An SDK for parsing OpenAPI (Swagger) 2.0 - 3.0 specifications
Project description
oapi
oapi
is a library and CLI for authoring python data models (for clients
or servers), and/or client libraries, for web APIs, based on an
OpenAPI specification (both OpenAPI/Swagger version 2
and version 3 are supported).
oapi
-generated packages/modules differ from those generated by other tools
(including but not limited to
swagger-codegen) in that
oapi
generates a data model which enforces the schemas defined
in the OpenAPI specification. This means that request and response objects
cannot comprise data types which differ from those specified in the spec,
and objects cannot have properties which are not defined. If an API
will add properties to an object which are not explicitly defined
in the schema properties, that object should have an
"additionalProperties" attribute, in which
case oapi
will treat these objects as dictionaries/mappings. oapi
also
fully supports polymorphism when a schema has an "anyOf", "allOf", or
"oneOf" attribute (although oapi
does not require a
discriminator to be defined). This design decision
could prove to be an annoyance to lazy developers of client applications, since
inaccurate OpenAPI schemas are endemic to many organizations. The author
of this library, however, asserts that end-to-end data validation is
absolutely essential for applications which are part of a critical data
pipeline. The author of this library is also of the opinion that when
encountering inaccurate OpenAPI specifications, you should fix the spec, and
if you are not the owner of the spec (and can't convince the owner to fix it),
you should script your fix in order to apply that same fix to future versions
of the specification.
Notable features of an oapi
generated client/model library include:
oapi
generated data models and clients are fully type-hinted (they will pass inspection bymypy
).oapi
generated data models and clients adhere to PEP-8 formatting standards, and will pass inspection byflake8
(with the default options).oapi
generated data models and clients include docstrings for all models, model properties, client methods, and client method parameters, inferred from "description" and "summary" attributes of elements within the specification.oapi
generated clients will handle the most common server-to-server authentication methods out-of-box, including the OAuth2 authorization code flow (client_id/client_secret), API keys, bearer tokens, HTTP basic auth, and most cookie-based authentication patterns. Custom authentication methods are also easily accomplished by specifying custom base classes and/or passing initialization decorators to theoapi client
shell command or to theoapi.client.create()
function.oapi
generated clients and models are easily updated. For instance:oapi
generated data model classes can be renamed using your favorite IDE's refactoring tools, and subsequent updates to that data model (such as to reflect minor-version updates to the spec which add endpoints, schemas, parameters, etc.) will retain your new class names, so long as the schema from which the class was generated remains in the same location within the spec. Class naming can also be customized by passing a custom hook to the get_class_name_from_pointer parameter foroapi.model.Module
oroapi.model.create
.
TODO: Finish README.md
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
File details
Details for the file oapi-1.62.8.tar.gz
.
File metadata
- Download URL: oapi-1.62.8.tar.gz
- Upload date:
- Size: 63.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.8.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 71b88602a0b95fa48e26ce04e737673bad73af8e80cacee8bee74faefed5b348 |
|
MD5 | 4a8317aff39fd083e3e9b4ea923d0cc5 |
|
BLAKE2b-256 | 7cf4542dc17e15c9c6707c21deedd5346f706430f53e25f6d4a8f4c1efc54498 |
File details
Details for the file oapi-1.62.8-py3-none-any.whl
.
File metadata
- Download URL: oapi-1.62.8-py3-none-any.whl
- Upload date:
- Size: 63.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.8.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 35cfeb076e372f7402642088a5a1208910f2c0a5861cbfac5e6940c56a0b1a5c |
|
MD5 | 6ebbf3ea4076437c41a66c8c62fa7090 |
|
BLAKE2b-256 | 932c42cc089f64547649df48d1270d5d55cfa6bed21d9cd01f5e17cda631d2c5 |