Review a Spring Boot API change end to end
A repeatable sequence for reviewing a Spring Boot API change: scope it, run a structured review, verify with tests, and write the PR description.
Cette ressource n’est disponible qu’en anglais.
Avant de commencer
- The change is on a branch with a clear description of intent.
- You can run the service's test suite locally.
Étapes
Scope the change
List the endpoints, DTOs and services that changed. Review only these plus their direct collaborators.
À vérifier avant de continuer
- You can state in one sentence what the change is supposed to do.
Run a structured review
Paste the changed controller, service and DTO code into the review prompt, choosing the focus that matches the risk.
Utilise: Review a Spring Boot REST APIÀ vérifier avant de continuer
- Every blocker or major finding has a concrete location and fix.
- Anything under "Needs more context" is resolved or noted.
Cover the gaps with tests
Turn the suggested tests into real ones for the riskiest paths, then run the suite.
Utilise: Write JUnit 5 tests for a Java classÀ vérifier avant de continuer
- New tests fail without the fix and pass with it.
- The full test command passes locally.
Write the pull request description
Summarize intent, changes, verification steps and risks for the reviewers.
Utilise: Write a pull request descriptionÀ vérifier avant de continuer
- A reviewer can reproduce your verification steps.
Résultat attendu
A reviewed change with test evidence and a pull request description reviewers can act on.
Ressources associées
A structured review prompt for Spring Boot controllers and services that checks API design, validation, error handling, security and performance, and returns findings ranked by severity.
SélectionnéKitLocalMis à jour avant-hier
spring-bootrestjavareview
À propos de ce catalogue
Instantané intégré · publié 15 nov. 2026, 06:05 · Révision du catalogue 5bc079fe355af2214bc0
Affichage de l’instantané intégré à l’application (aucune source de contenu n’est configurée). Du contenu plus récent peut exister à la source.