FwOpenAPI

Documenta endpoints REST com decorators OpenAPI/Swagger. Gera documentacao automatica navegavel.

Assinatura: @ApiOperation(summary, description) / @ApiParam(name, type)

Retorna: NIL (decorators)

FwOpenAPI permite gerar documentacao Swagger automaticamente de endpoints REST. Decorators marcam metadata; framework gera spec OpenAPI 3.0.

@Get("/api/v1/clientes/:id")
@ApiOperation(:summary "Busca cliente por ID", ;
              :description "Retorna detalhes completos do cliente")
@ApiParam(:name "id", :type "string", :description "Codigo do cliente")
@ApiResponse(:code 200, :description "Cliente encontrado")
@ApiResponse(:code 404, :description "Cliente nao existe")
function BuscaCliente(:id)
    // ...
return

Gerar Swagger UI

Acesse /api/docs apos ativar OpenAPI — interface visual de testar endpoints.

Pegadinhas

Veja também