Spring Boot Rest Api Standards

Opinionated REST API standards for Spring Boot that'll keep your endpoints consistent. Covers the fundamentals you need: resource-based URL design, proper HTTP method usage, DTO patterns with validation, global exception handling with RestControllerAdvice, and pagination setup. The examples are practical, showing complete CRUD controllers and error response structures you can actually use. The validation checkpoints are a nice touch, making sure you verify URL structure and status codes as you build. It's prescriptive about things like never exposing entities directly and always paginating large results, which is exactly what you want from a standards guide. If you're building APIs in Spring Boot and want to avoid the usual REST antipatterns, this gives you a solid foundation without overthinking it.

skills.sh installs: 4.3K
GitHub stars: 369
last updated: Aug 21, 2026

View on GitHub

Install

$ npx -y skills add giuseppe-trisciuoglio/developer-kit --skill spring-boot-rest-api-standards --agent claude-code

Installs into .claude/skills of the current project.

Files

Spring Boot REST API Standards

Overview

REST API design standards for Spring Boot covering URL design, HTTP methods, status codes, DTOs, validation, error handling, pagination, and security headers.

When to Use

Creating REST endpoints and API routes
Designing DTOs and API contracts
Implementing error handling and validation
Setting up pagination and filtering
Configuring security headers and CORS
Reviewing REST API architecture

Instructions

To Build RESTful API Endpoints

Follow these steps to create well-designed REST API endpoints:

Design Resource-Based URLs
- Use plural nouns for resource names
- Follow REST conventions: GET /users, POST /users, PUT /users/{id}
- Avoid action-based URLs like /getUserList
Implement Proper HTTP Methods
- GET: Retrieve resources (safe, idempotent)
- POST: Create resources (not idempotent)
- PUT: Replace entire resources (idempotent)
- PATCH: Partial updates (not idempotent)
- DELETE: Remove resources (idempotent)