302-frameworks-spring-boot-rest
This Claude Code skill provides comprehensive guidance for designing, reviewing, and improving REST APIs built with Spring Boot. Use it when working with HTTP methods, resource URIs, status codes, DTOs, API versioning, content negotiation, pagination, Bean Validation, idempotency, ETag concurrency, HTTP caching, error handling, OpenAPI contracts, and RFC 7807 problem details. It enforces Maven compilation verification before and after changes to ensure project integrity.
git clone --depth 1 https://github.com/jabrena/cursor-rules-java /tmp/302-frameworks-spring-boot-rest && cp -r /tmp/302-frameworks-spring-boot-rest/skills/302-frameworks-spring-boot-rest ~/.claude/skills/302-frameworks-spring-boot-restSKILL.md
# Java REST API Design Principles Apply REST API design principles for Spring Boot applications. **What is covered in this Skill?** - HTTP methods (GET, POST, PUT, PATCH, DELETE) — semantic consistency - Resource URI design - HTTP status codes - Request/response DTOs with lean contracts - API versioning (URI, header, or media type — applied consistently) - Bean Validation at the boundary (@Valid/@Validated on controller inputs, 400 on failure) - Pagination, sorting, and filtering (Page/Pageable with caps) - ISO-8601 instants with offset (OffsetDateTime, Instant) in JSON contracts - Content negotiation (JSON default; vendor media types when meaningful) - Idempotency-Key support for POST creates; 409 Conflict for collisions - ETag concurrency with If-Match/If-None-Match; 412 Precondition Failed / 304 Not Modified - HTTP caching discipline (Cache-Control, ETag, Last-Modified) - Deprecation and sunset headers (Deprecation, Sunset, Link rel="successor-version)" - Error handling - API security (TLS, authentication, authorization, input validation) - API contract: OpenAPI file as source of truth for API-first (OpenAPI Generator) - Controller advice and problem details (RFC 7807) **Scope:** Apply recommendations based on the reference rules and good/bad code examples. ## Constraints Before applying any REST API changes, ensure the project compiles. If compilation fails, stop immediately. After applying improvements, run full verification. - **MANDATORY**: Run `./mvnw compile` or `mvn compile` before applying any change - **SAFETY**: If compilation fails, stop immediately - **VERIFY**: Run `./mvnw clean verify` or `mvn clean verify` after applying improvements - **BEFORE APPLYING**: Read the reference for detailed rules and good/bad patterns - **EDGE CASE**: If request scope is ambiguous, stop and ask a clarifying question before applying changes - **EDGE CASE**: If required inputs, files, or tooling are missing, report what is missing and ask whether to proceed with setup guidance ## When to use this skill - Review Java code for Spring Boot REST API - Apply best practices for Spring Boot REST API in Java code ## Workflow 1. **Read reference and assess project context** Read `references/302-frameworks-spring-boot-rest.md` and inspect the current project setup before proposing changes. 2. **Gather scope and decide target improvements** Identify requested outcomes, constraints, and the minimum safe set of changes to apply. 3. **Apply framework-aligned changes** Implement or refactor configuration/code following the reference patterns and project conventions. 4. **Run verification and report results** Execute appropriate build/tests and summarize what changed, what was verified, and any follow-up actions. ## Reference For detailed guidance, examples, and constraints, see [references/302-frameworks-spring-boot-rest.md](references/302-frameworks-spring-boot-rest.md).
Use when you need to generate a checklist document with Java system prompts, following the embedded template exactly and producing INVENTORY-SKILLS-JAVA.md in the project root. This should trigger for requests such as Create Java system prompts checklist; Generate INVENTORY-SKILLS-JAVA.md; Use @001-skills-inventory. Part of cursor-rules-java project
Use when you need to generate a checklist document with embedded agents inventory, following the embedded template exactly and producing INVENTORY-AGENTS-JAVA.md in the project root. This should trigger for requests such as Create embedded agents inventory checklist; Generate INVENTORY-AGENTS-JAVA.md; Use @002-agents-inventory. Part of cursor-rules-java project
Use when you need to install the embedded robot agents into either .cursor/agents or .claude/agents, selecting the destination interactively and copying the embedded agent definitions from project assets. This should trigger for requests such as Install embedded agents; Bootstrap .cursor/agents; Bootstrap .claude/agents; Copy robot agents. Part of cursor-rules-java project
Guides the creation of agile epics with comprehensive definition including business value, success criteria, and breakdown into user stories. Use when the user wants to create an agile epic, define large bodies of work, break down features into user stories, or document strategic initiatives. This should trigger for requests such as Create an agile epic; Write an epic; I need to create an epic; Define an epic; Epic definition. Part of cursor-rules-java project
Guides the creation of detailed agile feature documentation from an existing epic. Use when the user wants to split an epic into feature files, derive features with scope and acceptance criteria, or plan feature documentation for stakeholders or engineering. This should trigger for requests such as Create features from an epic; Split epic into features; Feature files from epic; Derive features from epic. Part of cursor-rules-java project
Guides the creation of agile user stories and Gherkin feature files. Use when the user wants to create a user story, write acceptance criteria, define Gherkin scenarios, or author BDD feature files. This should trigger for requests such as Create a user story; Write a user story; I need to write a user story. Part of cursor-rules-java project
Use when you need to generate Architecture Decision Records (ADRs) for a Java project through an interactive, conversational process that systematically gathers context, stakeholders, options, and outcomes to produce well-structured ADR documents. This should trigger for requests such as Generate ADR; Create Architecture Decision Record; Document architecture decision; Architecture Decision Record for Java. Part of cursor-rules-java project
Facilitates conversational discovery to create Architectural Decision Records (ADRs) for functional requirements covering CLI, REST/HTTP APIs, or both. Use when the user wants to document command-line or HTTP service architecture, capture functional requirements, create ADRs for CLI or API projects, or design interfaces with documented decisions. This should trigger for requests such as Create ADR for functional requirements; Document functional requirements; Capture functional requirements; Generate functional requirements in an ADR. Part of cursor-rules-java project