Generate modern Python clients from OpenAPI
This project is still in early development and does not support all OpenAPI features
The Python clients generated by openapi-generator support Python 2 and therefore come with a lot of baggage. This tool aims to generate clients which:
- Use all the latest and greatest Python features like type annotations and dataclasses
- Don't carry around a bunch of compatibility code for older version of Python (e.g. the
sixpackage) - Have better documentation and more obvious usage instructions
Additionally, because this generator is written in Python, it should be more accessible to contribution by the people using it (Python developers).
pip install openapi-python-client
Then, if you want tab completion: openapi-python-client --install-completion
openapi-python-client generate --url https://my.api.com/openapi.json
This will generate a new client library named based on the title in your OpenAPI spec. For example, if the title of your API is "My API", the expected output will be "my-api-client". If a folder already exists by that name, you'll get an error.
openapi-python-client update --url https://my.api.com/openapi.json
- A
pyproject.tomlfile with some basic metadata intended to be used with Poetry. - A
README.mdyou'll most definitely need to update with your project's details - A Python module named just like the auto-generated project name (e.g. "my_api_client") which contains:
- A
clientmodule which will have both aClientclass and anAuthenticatedClientclass. You'll need these for calling the functions in theapimodule. - An
apimodule which will contain one module for each tag in your OpenAPI spec, as well as adefaultmodule for endpoints without a tag. Each of these modules in turn contains one function for calling each endpoint. - A
modelsmodule which has all the classes defined by the various schemas in your OpenAPI spec
- A
- All HTTP Methods
- JSON and form bodies, path and query parameters
- float, string, int, datetimes, string enums, and custom schemas or lists containing any of those
- html/text or application/json responses containing any of the previous types
- Bearer token security
- Dylan Anthony [email protected] (Owner)