Generate modern Python clients from OpenAPI
Project description
openapi-python-client
Generate modern Python clients from OpenAPI
This project is still in early development and does not support all OpenAPI features
Why This?
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
six
package) - 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).
Installation
pip install openapi-python-client
Then, if you want tab completion: openapi-python-client --install-completion
Usage
Create a new client
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.
Update an existing client
openapi-python-client update --url https://my.api.com/openapi.json
What You Get
- A
pyproject.toml
file with some basic metadata intended to be used with Poetry. - A
README.md
you'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
client
module which will have both aClient
class and anAuthenticatedClient
class. You'll need these for calling the functions in theapi
module. - An
api
module which will contain one module for each tag in your OpenAPI spec, as well as adefault
module for endpoints without a tag. Each of these modules in turn contains one function for calling each endpoint. - A
models
module which has all the classes defined by the various schemas in your OpenAPI spec
- A
OpenAPI features supported
- 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
Contributors
- Dylan Anthony danthony@triaxtec.com (Owner)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for openapi-python-client-0.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d9153f03a8fedfc1dd5d5db855e0fb1208da11f67d8f08c4bd063503913c2dbd |
|
MD5 | b38d7119f1456b8b8073027e99e10f5c |
|
BLAKE2b-256 | 20c989517e21014a2621f0fb44b9e3868028f53d7ad150f61bd958068c0880db |
Hashes for openapi_python_client-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c8c86a4317f812ef8113d4152dba46b7a8a7f0a4c202856805a6e3ed55f58b4 |
|
MD5 | 777fae3432bfdaf8519784ebb8261874 |
|
BLAKE2b-256 | 4c1acfd6b004fc247e24fdee702bf3b0fd249510bfe10b0288121e9cc237752c |