Skip to content

Commit b143313

Browse files
authored
Update readme with pip installation procedure (#20353)
* add pip install to readme * add a few links to blogs
1 parent 7f0efe7 commit b143313

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ OpenAPI Generator allows generation of API client libraries (SDK generation), se
106106
- [1.5 - Homebrew](#15---homebrew)
107107
- [1.6 - Docker](#16---docker)
108108
- [1.7 - NPM](#17---npm)
109+
- [1.8 - pip](#18---pip)
109110
- [2 - Getting Started](#2---getting-started)
110111
- [3 - Usage](#3---usage)
111112
- [3.1 - Customization](#31---customization)
@@ -449,6 +450,29 @@ npm install @openapitools/openapi-generator-cli -D
449450

450451
You can use [locally built JARs](https://github.com/OpenAPITools/openapi-generator-cli?tab=readme-ov-file#use-locally-built-jar) or [`SNAPSHOT` versions](https://github.com/OpenAPITools/openapi-generator-cli?tab=readme-ov-file#use-nightly-snapshot-build) as well.
451452

453+
### [1.8 - pip](#table-of-contents)
454+
455+
456+
> **Platform(s)**: Linux, macOS, Windows
457+
**Install** via [PyPI](https://pypi.org/) (`java` executable is needed to run):
458+
459+
```
460+
pip install openapi-generator-cli
461+
```
462+
463+
To install a specific version
464+
```
465+
pip install openapi-generator-cli==7.10.0
466+
```
467+
468+
You can also install with [jdk4py](https://github.com/activeviam/jdk4py) instead of java binary. (python>=3.10 is required)
469+
470+
```
471+
pip install openapi-generator-cli[jdk4py]
472+
```
473+
474+
Ref: https://github.com/openAPITools/openapi-generator-pip
475+
452476
## [2 - Getting Started](#table-of-contents)
453477

454478
To generate a PHP client for [petstore.yaml](https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml), please run the following
@@ -944,6 +968,10 @@ Here are some companies/projects (alphabetical order) using OpenAPI Generator in
944968
- 2024-03-04 - [Generating TypeScript Types with OpenAPI for REST API Consumption](https://www.pullrequest.com/blog/generating-typescript-types-with-openapi-for-rest-api-consumption/) by [PullRequest](https://www.pullrequest.com/)
945969
- 2024-03-07 - [Fully typed Web Apps with OpenAPI (Part 1)](https://medium.com/@gfox1984/fully-typed-web-apps-with-openapi-part-1-595d55766670) by [Guillaume Renard](https://medium.com/@gfox1984)
946970
- 2024-03-08 - [Laravel OpenAPIによる "辛くない" スキーマ駆動開発](https://fortee.jp/phperkaigi-2024/proposal/9e2e6c38-d078-4efa-99b4-83ebf9033b34) by [KentarouTakeda](https://twitter.com/KentarouTakeda)
971+
- 2024-04-04 - [Working with OpenAPI using Rust](https://www.shuttle.dev/blog/2024/04/04/using-openapi-rust) by [Joshua Mo](https://twitter.com/joshmo_dev)
972+
- 2024-04-08 - [Implement API first strategy with OpenAPI generator plugin](https://medium.com/javarevisited/implement-api-first-strategy-with-openapi-generator-plugin-e4bbe7f0d778) by [Rui Zhou](https://medium.com/@wirelesser)
973+
- 2024-05-06 - [OpenAPI Generator Custom Templates](https://www.javacodegeeks.com/openapi-generator-custom-templates.html) by [Mary Zheng](https://www.javacodegeeks.com/author/mary-zheng)
974+
947975

948976
## [6 - About Us](#table-of-contents)
949977

0 commit comments

Comments
 (0)