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/good-controller.java
View on GitHub// GOOD — proper response envelope, correct status, no entity leakage
@RestController
@RequestMapping("/api/{version}/orders") // path-segment versioning: /api/v1/orders, /api/v1.1/orders
@RequiredArgsConstructor
public class OrderController {
private final OrderService orderService;
@PostMapping
public ResponseEntity<ApiResponse<OrderResponse>> create(
@Valid @RequestBody CreateOrderRequest request
) {
Order order = orderService.createOrder(request);
return ResponseEntity
.status(HttpStatus.CREATED)
.body(ApiResponse.ok(OrderResponse.from(order)));
}
@GetMapping("/{id}")
public ApiResponse<OrderResponse> getById(@PathVariable UUID id) {
return ApiResponse.ok(OrderResponse.from(orderService.findById(id)));
}
@GetMapping
public ApiResponse<PageResponse<OrderResponse>> list(Pageable pageable) {
return ApiResponse.ok(PageResponse.from(orderService.findAll(pageable).map(OrderResponse::from)));
}
@DeleteMapping("/{id}")
@ResponseStatus(HttpStatus.NO_CONTENT)
public void delete(@PathVariable UUID id) {
orderService.delete(id);
}
}
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 |