tiagofrancarita/DoaFacil-Backend

docs: Criar documentação Swagger da API inicial

Open

#3 opened on Jun 23, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Java (2 forks)auto 404
documentationhelp wanted

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Adicionar suporte à documentação interativa da API REST utilizando Swagger/OpenAPI.

Tarefas: Incluir dependência do SpringDoc OpenAPI Criar config básica Testar no endpoint /swagger-ui.html

Contributor guide

Research direction
Add the SpringDoc OpenAPI dependency (springdoc openapi starter webmvc ui) to your pom.xml (Maven) or build.gradle (Gradle). Create a configuration class or simply enable via application.properties. After running the application, verify the documentation is accessible at /swagger ui.html.
Tech stack
javaspring
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85