General - How To - Recipes¶

Here are several pointers to other places in the docs, for general or frequent questions.

Filter Data - Security¶

To ensure that you don't return more data than you should, read the docs forTutorial - Response Model - Return Type.

Documentation Tags - OpenAPI¶

To add tags to yourpath operations, and group them in the docs UI, read the docs forTutorial - Path Operation Configurations - Tags.

Documentation Summary and Description - OpenAPI¶

To add a summary and description to yourpath operations, and show them in the docs UI, read the docs forTutorial - Path Operation Configurations - Summary and Description.

Documentation Response description - OpenAPI¶

To define the description of the response, shown in the docs UI, read the docs forTutorial - Path Operation Configurations - Response description.

Documentation Deprecate aPath Operation - OpenAPI¶

To deprecate apath operation, and show it in the docs UI, read the docs forTutorial - Path Operation Configurations - Deprecation.

Convert any Data to JSON-compatible¶

To convert any data to JSON-compatible, read the docs forTutorial - JSON Compatible Encoder.

OpenAPI Metadata - Docs¶

To add metadata to your OpenAPI schema, including a license, version, contact, etc, read the docs forTutorial - Metadata and Docs URLs.

OpenAPI Custom URL¶

To customize the OpenAPI URL (or remove it), read the docs forTutorial - Metadata and Docs URLs.

OpenAPI Docs URLs¶

To update the URLs used for the automatically generated docs user interfaces, read the docs forTutorial - Metadata and Docs URLs.