Ir para o conteúdo

Geral - Como Fazer - Receitas

Aqui estão vários links para outros locais na documentação, para perguntas gerais ou frequentes

Filtro de dados- Segurança

Para assegurar que você não vai retornar mais dados do que deveria, leia a seção Tutorial - Response Model - Return Type.

Tags de Documentação - OpenAPI

Para adicionar tags às suas rotas e agrupá-las na UI da documentação, leia a seção Tutorial - Path Operation Configurations - Tags.

Resumo e Descrição da documentação - OpenAPI

Para adicionar um resumo e uma descrição às suas rotas e exibi-los na UI da documentação, leia a seção Tutorial - Path Operation Configurations - Summary and Description.

Documentação das Descrições de Resposta - OpenAPI

Para definir a descrição de uma resposta exibida na interface da documentação, leia a seção Tutorial - Path Operation Configurations - Response description.

Documentação para Depreciar uma Operação de Rota - OpenAPI

Para depreciar uma operação de rota e exibi-la na interface da documentação, leia a seção Tutorial - Path Operation Configurations - Deprecation.

Converter qualquer dado para JSON

Para converter qualquer dado para um formato compatível com JSON, leia a seção Tutorial - JSON Compatible Encoder.

OpenAPI Metadata - Docs

Para adicionar metadados ao seu esquema OpenAPI, incluindo licensa, versão, contato, etc, leia a seção Tutorial - Metadata and Docs URLs.

OpenAPI com URL customizada

Para customizar a URL do OpenAPI (ou removê-la), leia a seção Tutorial - Metadata and Docs URLs.

URLs de documentação do OpenAPI

Para alterar as URLs usadas ​​para as interfaces de usuário da documentação gerada automaticamente, leia a seção Tutorial - Metadata and Docs URLs.