swagger

Home > Swagger e Postman

Documentação automática: Swagger e Postman

Desde a 1.0 · Nível: iniciante

Em uma frase: o TRALSwaggerModule gera uma página com todas as rotas do servidor, onde dá para testar cada uma, e um arquivo para o Postman.

Ligar

Coloque um TRALSwaggerModule (paleta RAL - Modules):

RALSwaggerModule1.Server := Servidor;
RALSwaggerModule1.Title := 'API da Loja';
RALSwaggerModule1.SystemVersion := '1.0';

Abra http://localhost:8000/swagger no navegador.

Endereço	O que é
/swagger	a página
/swagger/swagger.json	a descrição OpenAPI 3.0 (para outras ferramentas)
/swagger/postman.json	a coleção do Postman (com PostmanTag := True)

Propriedades

Propriedade	O que faz
Domain	onde a página fica (padrão /swagger)
Title, SystemVersion, SystemDescription	título, versão e texto de apresentação
EMail, License, TermsOfService	dados de contato e licença
ServersUrl	endereços do servidor que a página oferece para testar, um por linha
RequireAuth	True: a página e o JSON pedem o login do servidor (padrão: públicos)
PostmanTag	publica /postman.json
SwaggerFile, PostmanFile	grava os JSON nesses arquivos
ShowCustomNames	mostra o Name da rota

O que aparece

Cada rota, com o método, a descrição (o terceiro parâmetro de CreateRoute) e os InputParams (Rotas). Descreva as rotas e os parâmetros para a página ficar útil.

Note

A página carrega o Swagger UI de um CDN (unpkg.com), com verificação de integridade: o navegador de quem abre precisa de internet.

Veja também

• Rotas e parâmetros
• Segurança para produção: RequireAuth em produção