Skip to content

Commit 92b5f63

Browse files
committed
chore: Update library name to openapi-code-gen and improve documentation and code generation
1 parent 7b4924f commit 92b5f63

2 files changed

Lines changed: 11 additions & 11 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

2-
# API Code Generator
2+
# Open API Code Gen
33

4-
API Code Generator is a JavaScript library designed to convert OpenAPI schemas into various code examples. This tool simplifies the process of generating client libraries in different programming languages based on your API documentation.
4+
Openapi-code-gen is a JavaScript library designed to convert OpenAPI schemas into various code examples. This tool simplifies the process of generating client libraries in different programming languages based on your API documentation.
55

66
## Features
77

@@ -10,7 +10,7 @@ API Code Generator is a JavaScript library designed to convert OpenAPI schemas i
1010

1111
## Prerequisites
1212

13-
Before installing `api-code-generator`, ensure you have the following installed:
13+
Before installing `openapi-code-gen`, ensure you have the following installed:
1414

1515
- [Node.js](https://nodejs.org/) (version 12 or higher)
1616
- npm (Node package manager)
@@ -23,20 +23,20 @@ npm install -g openapi-to-postmanv2
2323

2424
## Installation
2525

26-
To install `api-code-generator`, run the following command:
26+
To install `openapi-code-gen`, run the following command:
2727

2828
```bash
29-
npm install api-code-generator
29+
npm install openapi-code-gen
3030
```
3131

3232
## Usage
3333

34-
Once installed, you can use `api-code-generator` from the command line to generate code examples from your OpenAPI schemas.
34+
Once installed, you can use `openapi-code-gen` from the command line to generate code examples from your OpenAPI schemas.
3535

3636
### Generate Code Examples
3737

3838
```bash
39-
api-code-generator generate -i path/to/your/openapi/schema.yaml -l language -v variant -o path/to/output/code_example
39+
openapi-code-gen generate -i path/to/your/openapi/schema.yaml -l language -v variant -o path/to/output/code_example
4040
```
4141

4242
### Options
@@ -92,13 +92,13 @@ The tool supports generating code examples for the following languages and varia
9292
### Example 1: Generate Python Requests Code Example
9393

9494
```bash
95-
api-code-generator generate -i ./schemas/api.yaml -l Python -v Requests -o ./examples/python_requests_example.py
95+
openapi-code-gen generate -i ./schemas/api.yaml -l Python -v Requests -o ./examples/python_requests_example.py
9696
```
9797

9898
### Example 2: Generate JavaScript Fetch Code Example
9999

100100
```bash
101-
api-code-generator generate -i ./schemas/api.yaml -l JavaScript -v Fetch -o ./examples/js_fetch_example.js
101+
openapi-code-gen generate -i ./schemas/api.yaml -l JavaScript -v Fetch -o ./examples/js_fetch_example.js
102102
```
103103

104104
## Contributing

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{
2-
"name": "api-code-generator",
2+
"name": "openapi-code-gen",
33
"version": "1.0.0",
44
"description": "A JavaScript library to convert OpenAPI schema to Postman collection and generate sample code.",
55
"main": "src/index.js",
66
"scripts": {
77
"start": "node src/index.js"
88
},
99
"bin": {
10-
"api-code-generator": "src/index.js"
10+
"openapi-code-gen": "src/index.js"
1111
},
1212
"keywords": [],
1313
"author": "",

0 commit comments

Comments
 (0)