mirror of https://github.com/tiangolo/fastapi.git
40 lines
2.3 KiB
Markdown
40 lines
2.3 KiB
Markdown
# 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 for [Tutorial - Response Model - Return Type](../tutorial/response-model.md){.internal-link target=_blank}.
|
|
|
|
## Documentation Tags - OpenAPI
|
|
|
|
To add tags to your *path operations*, and group them in the docs UI, read the docs for [Tutorial - Path Operation Configurations - Tags](../tutorial/path-operation-configuration.md#tags){.internal-link target=_blank}.
|
|
|
|
## Documentation Summary and Description - OpenAPI
|
|
|
|
To add a summary and description to your *path operations*, and show them in the docs UI, read the docs for [Tutorial - Path Operation Configurations - Summary and Description](../tutorial/path-operation-configuration.md#summary-and-description){.internal-link target=_blank}.
|
|
|
|
## Documentation Response description - OpenAPI
|
|
|
|
To define the description of the response, shown in the docs UI, read the docs for [Tutorial - Path Operation Configurations - Response description](../tutorial/path-operation-configuration.md#response-description){.internal-link target=_blank}.
|
|
|
|
## Documentation Deprecate a *Path Operation* - OpenAPI
|
|
|
|
To deprecate a *path operation*, and show it in the docs UI, read the docs for [Tutorial - Path Operation Configurations - Deprecation](../tutorial/path-operation-configuration.md#deprecate-a-path-operation){.internal-link target=_blank}.
|
|
|
|
## Convert any Data to JSON-compatible
|
|
|
|
To convert any data to JSON-compatible, read the docs for [Tutorial - JSON Compatible Encoder](../tutorial/encoder.md){.internal-link target=_blank}.
|
|
|
|
## OpenAPI Metadata - Docs
|
|
|
|
To add metadata to your OpenAPI schema, including a license, version, contact, etc, read the docs for [Tutorial - Metadata and Docs URLs](../tutorial/metadata.md){.internal-link target=_blank}.
|
|
|
|
## OpenAPI Custom URL
|
|
|
|
To customize the OpenAPI URL (or remove it), read the docs for [Tutorial - Metadata and Docs URLs](../tutorial/metadata.md#openapi-url){.internal-link target=_blank}.
|
|
|
|
## OpenAPI Docs URLs
|
|
|
|
To update the URLs used for the automatically generated docs user interfaces, read the docs for [Tutorial - Metadata and Docs URLs](../tutorial/metadata.md#docs-urls){.internal-link target=_blank}.
|