doc: cria documentação da api - #75
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive API documentation for the Reminder API using Spring REST Docs. The documentation is generated automatically from controller tests and is available in both English and Portuguese.
- Integrates Spring REST Docs into the test suite to generate API documentation snippets
- Creates bilingual AsciiDoc documentation files covering all reminder CRUD operations and error scenarios
- Adds the necessary Maven dependency and configuration for documentation generation
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/test/java/br/com/springnoobs/reminderapi/reminder/controller/ReminderControllerTest.java | Added @AutoConfigureRestDocs annotation and document() calls to all test methods to generate REST Docs snippets; refactored imports to use wildcard for MockMvcRequestBuilders |
| src/docs/asciidoc/index-pt-BR.adoc | Created Portuguese API documentation with complete coverage of all endpoints, HTTP verbs, status codes, and example requests/responses |
| src/docs/asciidoc/index-en-US.adoc | Created English API documentation mirroring the Portuguese version with consistent structure and content |
| pom.xml | Added spring-restdocs.version property (3.0.5) and cleaned up indentation for quartz dependencies |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
lucasbdourado
self-requested a review
December 6, 2025 15:00
lucasbdourado
approved these changes
Dec 6, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.