rrezartprebreza/spring-boot-skills / skills/spring-boot-4/rest-api-conventions
rest-api-conventions
VerifiedUse when generating REST controllers, DTOs, success response contracts, pagination, HTTP status mapping, or API versioning. For RFC 9457 exception and error response formatting, use problem-details-rfc9457 unless the project explicitly requires a legacy error envelope.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 9.9 KB |
| agents/openai.yaml | config | 202 B |
| examples/bad-controller.java | other | 1.3 KB |
| examples/good-controller.java | other | 1.2 KB |
| templates/ApiResponse.java | other | 925 B |
| templates/GlobalExceptionHandler.java | other | 3.3 KB |
| templates/PageResponse.java | other | 546 B |
examples/bad-controller.java
View on GitHub// BAD — all the common mistakes in one controller
@RestController
@RequestMapping("/orders") // preserve the project route prefix
public class OrderController {
@Autowired // field injection
private OrderRepository orderRepository; // direct repo, no service layer
@PostMapping
public Order createOrder(@RequestBody CreateOrderRequest request) { // returns entity directly
Order order = new Order(); // no factory method
order.setEmail(request.getEmail());
return orderRepository.save(order); // entity leakage; missing creation status
}
@GetMapping("/{id}")
public Map<String, Object> getOrder(@PathVariable Long id) { // ID type is not the problem; authorization still matters
Optional<Order> order = orderRepository.findById(id);
if (!order.isPresent()) {
return Map.of("error", "not found"); // ad-hoc error, no status code
}
return Map.of("data", order.get()); // raw map, entity leakage
}
@GetMapping
public List<Order> getAllOrders() { // no pagination, returns all rows
return orderRepository.findAll();
}
@DeleteMapping("/{id}")
public String delete(@PathVariable Long id) {
orderRepository.deleteById(id);
return "deleted"; // 200 with body instead of 204
}
}
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementation | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirements | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallback | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions always | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |