Generate API clients by parsing Swagger definitions
Swagger codegen for Python
pip install swagger-codegen
Currently, only OpenApi 3.x (aka Swagger 3) is supported.
# Generate Petstore Api client using 'petstore' package name. swagger_codegen generate https://petstore3.swagger.io/api/v3/openapi.json petstore python Python 3.8.1 (default, Jan 23 2020, 13:58:52) [Clang 11.0.0 (clang-118.104.22.168)] on darwin Type "help", "copyright", "credits" or "license" for more information. >>> from petstore import new_client, Configuration >>> from swagger_codegen.api.adapter.requests import RequestsAdapter >>> from petstore.apis.user.createUser import User >>> client = new_client(RequestsAdapter(), Configuration(host="http://petstore3.swagger.io")) >>> pets = client.pet.findPetsByStatus() >>> print(pets) [Pet(category=Category(id=1, name='Dogs'), id=69, name='aHldog', photoUrls=['string'], status='available',...]
You can test example client with following command:
# Run from project directory. python -m example.petstore_example
Code generators (also known as renderers)
There are two code generator strategies in project:
- Render client as usual python package via
- Render client as installable python package via
You can choose what renderer to use by specifying
renderer key in
file. Please see
.swagger-codegen.toml.example for allowed values.
- Content of generated files differs run-to-run because each time functions or data transfer objects ordered differently. Functionally clients stay the same, but each time the code is generated there are a large diff generated by git.
- Not fully Openapi compliant: the project was built to fulfill my personal needs:
a support for FastAPI-generated schemas, and I needed this feature quickly,
that is why there are too many large dependencies (
schemathesis) and incompatibilities. Anyway, I'm looking forward to fixing this issues by time.
- There are may be delays in reaction to issues due to small amount of free time (however PR's with tests are merged asap).
Work in progress
Though library gives nice results for generated API, it is still in development. Some tests are missing. API is a subject to change until stable release.
Anyway backward compatibility will be kept as much as possible.
The code is not optimized yet and mostly dirty because the project was born as a holiday prototype.
example directory may be out of sync with actual generated code.
You can see all people who helped this project at the contributors page
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for swagger_codegen-0.1.31-py3-none-any.whl