Skip to content

chore: Update Readme.md #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sumansaurabh merged 1 commit into from
Jun 9, 2024
Merged

chore: Update Readme.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,29 @@ Once installed, you can use `penify-oapi-codegen` from the command line to gener

### Generate Code Examples

#### For all supported languages

It will generate OpenAPI schema for all possible language and variant.

```bash
penify-oapi-codegen -i path/to/your/openapi/schema.json -o path/to/output/schema_with_code.json
```

#### For Specific Language and Variant

```bash
penify-oapi-codegen -i path/to/your/openapi/schema.json -l language -v variant -o path/to/output/schema_with_code.json
```

#### Get all supported languages

```bash
penify-oapi-codegen -s
```

### Options

- `-s, --source <path>`: Path to the OpenAPI schema file (required).
- `-i, --input <path>`: Path to the OpenAPI schema file (required).
- `-l, --language <language>`: Programming language for the code example (optional).
- `-v, --variant <variant>`: Variant of the code generator for the specified language (optional).
- `-o, --output <path>`: Path to the output code example file (optional).
Expand Down