Suporte a OpenAPI (Swagger)
O poder das ferramentas Swagger começa com a especificação OpenAPI — o padrão da indústria para design de API RESTful
Visão Geral do Swagger
Swagger oferece as ferramentas mais poderosas e fáceis de usar para aproveitar completamente a especificação OpenAPI. Essas ferramentas podem ajudá-lo a projetar, construir, documentar e consumir APIs REST.
Visão Geral de OpenAPI
Especificação OpenAPI (anteriormente conhecida como Especificação Swagger) é um formato de descrição de API para APIs REST. Um arquivo OpenAPI permite descrever sua API completa, incluindo:
- Endpoints disponíveis (/users) e operações em cada endpoint (GET /users, POST /users)
Configurar Endpoints
- Parâmetros de operação entrada e saída para cada operação
Definir Parâmetros de Endpoints/Apps
- Métodos de autenticação
- Informações de contato, licença, termos de uso e outras informações
As especificações de API podem ser escritas em YAML ou JSON. O formato é fácil de aprender e legível tanto para humanos quanto para máquinas. A especificação OpenAPI completa pode ser encontrada no GitHub: OpenAPI 3.0 Specification. Mais sobre OpenAPI aqui.
Demonstração do Swagger
Especificar definição Swagger
Neste ponto, você pode especificar uma URL de arquivo Swagger (json/yaml) ou Fazer upload de uma definição. Após carregá-la, uma Configurar endpoints aparecerá.
O lado esquerdo do diálogo Configurar endpoints consiste em:
- URL Base - pode ser preenchida automaticamente se um valor para ela estiver presente na definição do arquivo
- Autorização - forneça chave de auth se necessário
- Visualização em árvore de endpoints - Todos os endpoints disponíveis serão carregados aqui junto com seu tipo (GET, PUT, POST, etc.)
O lado direito do diálogo Configurar endpoints consiste em:
- URL de requisição com botão Enviar que pode ser usado para testar a conexão antes de selecioná-lo
- Elementos de guia para autorização, parâmetros e cabeçalhos - se um for necessário, será marcado como tal.
- Seção de conteúdo de guia mostrando mensagens info ou campos obrigatórios. Exemplo de imagem:
Diálogo Configurar Endpoints
Usando fonte de dados de fontes de rede local
Agora você pode fazer requisições para localhost ou redes privadas. Para mais informações, confira a seção uso de redes privadas do tópico Usando dados em seu aplicativo
Uso de fontes de rede local
