Skip to content

feat: Documentação OpenAPI — Swagger UI #2

@devrafaelsoares

Description

@devrafaelsoares

Descrição

Adicionar documentação interativa da API com springdoc-openapi e Swagger UI.

Tarefas

  • Adicionar dependência springdoc-openapi-starter-webmvc-ui
  • Criar OpenApiConfig.java com info da API (título, versão, descrição, contato)
  • Anotar endpoints do AuthController com @Operation, @ApiResponse
  • Anotar DTOs com @Schema para descrições dos campos
  • Configurar endpoint do Swagger como público no SecurityConfig
  • Adicionar link do Swagger no README

Resultado esperado

Swagger UI acessível em /swagger-ui.html com todos os endpoints documentados.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions