| 1 |
OpenAPI |
| 2 |
======= |
| 3 |
|
| 4 |
Litestar has first class OpenAPI support offering the following features: |
| 5 |
|
| 6 |
- Automatic `OpenAPI 3.1.0 Schema <https://spec.openapis.org/oas/v3.1.0>`_ generation, which is available as both YAML |
| 7 |
and JSON. |
| 8 |
- Builtin support for static documentation site generation using several different libraries. |
| 9 |
- Full configuration using pre-defined type-safe dataclasses. |
| 10 |
|
| 11 |
|
| 12 |
Litestar includes a complete implementation of the `latest version of the OpenAPI specification <https://spec.openapis.org/oas/latest.html>`_ |
| 13 |
using Python dataclasses. This implementation is used as a basis for generating OpenAPI specs, |
| 14 |
supporting :func:`~dataclasses.dataclass`, :class:`~typing.TypedDict`, |
| 15 |
as well as Pydantic and msgspec models, and any 3rd party entities |
| 16 |
for which a :ref:`plugin <plugins>` is implemented. |
| 17 |
|
| 18 |
This is also highly configurable - and users can customize the OpenAPI spec in a variety of ways - ranging from passing |
| 19 |
configuration globally to setting |
| 20 |
:ref:`specific kwargs on route <usage/openapi/schema_generation:Configuring schema generation on a route handler>` |
| 21 |
handler decorators. |
| 22 |
|
| 23 |
.. toctree:: |
| 24 |
|
| 25 |
schema_generation |
| 26 |
ui_plugins |