11[ ![ triaxtec] ( https://circleci.com/gh/triaxtec/openapi-python-client.svg?style=svg )] ( https://circleci.com/gh/triaxtec/openapi-python-client )
2- [ ![ Code style: black] ( https://img.shields.io/badge/code%20style-black-000000.svg )] ( https://github.com/ambv/black )
32[ ![ codecov] ( https://codecov.io/gh/triaxtec/openapi-python-client/branch/master/graph/badge.svg )] ( https://codecov.io/gh/triaxtec/openapi-python-client )
43[ ![ PyPI version shields.io] ( https://img.shields.io/pypi/v/openapi-python-client.svg )] ( https://pypi.python.org/pypi/openapi-python-client/ )
4+ [ ![ MIT license] ( https://img.shields.io/badge/License-MIT-blue.svg )] ( https://lbesson.mit-license.org/ )
5+ [ ![ Generic badge] ( https://img.shields.io/badge/type_checked-mypy-informational.svg )] ( https://mypy.readthedocs.io/en/stable/introduction.html )
6+ [ ![ Code style: black] ( https://img.shields.io/badge/code%20style-black-000000.svg )] ( https://github.com/ambv/black )
7+
58
69# openapi-python-client
710Generate modern Python clients from OpenAPI
@@ -51,20 +54,21 @@ get an error.
5154 for endpoints without a tag. Each of these modules in turn contains one function for calling each endpoint.
5255 1 . A ` models ` module which has all the classes defined by the various schemas in your OpenAPI spec
5356
54- For a full example you can look at tests/ test_end_to_end which has a declared [ FastAPI] ( https://fastapi.tiangolo.com/ )
57+ For a full example you can look at the ` test_end_to_end ` directory which has a declared [ FastAPI] ( https://fastapi.tiangolo.com/ )
5558server and the resulting openapi.json file in the "fastapi" directory. "golden-master" is the generated client from that
5659OpenAPI document.
5760
5861## OpenAPI features supported
59621 . All HTTP Methods
60631 . JSON and form bodies, path and query parameters
64+ 1 . File uploads with multipart/form-data bodies
61651 . float, string, int, date, datetime, string enums, and custom schemas or lists containing any of those
62661 . html/text or application/json responses containing any of the previous types
63671 . Bearer token security
6468
6569## Configuration
66- You can pass a YAML (or JSON) file to openapi-python-client in order to change some behavior. The following parameters
67- are supported:
70+ You can pass a YAML (or JSON) file to openapi-python-client with the ` --config ` option in order to change some behavior.
71+ The following parameters are supported:
6872
6973### class_overrides
7074Used to change the name of generated model classes. This param should be a mapping of existing class name
@@ -84,9 +88,5 @@ The easiest way to find what needs to be overridden is probably to generate your
8488 models folder.
8589
8690
87- ## Contributors
88- - Dylan Anthony <danthony@triaxtec.com> (Owner)
89-
90-
9191[CHANGELOG.md]: CHANGELOG.md
9292[Poetry]: https://python-poetry.org/
0 commit comments