spring-rest-api

Design Spring Boot REST APIs with OpenAPI docs, pagination, and HATEOAS support.

Updated Feb 7, 2026
One-click install
npx skills add https://github.com/gazolla/gazapps-java-skills --skill spring-rest-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: spring-rest-api
Source: https://github.com/gazolla/gazapps-java-skills/tree/main/spring-rest-api
Command: npx skills add https://github.com/gazolla/gazapps-java-skills --skill spring-rest-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Spring Boot REST API design and governance enabling production-grade APIs with OpenAPI docs, robust error handling, and standardized patterns including pagination, content negotiation, CORS, and HATEOAS.

Core Features & Use Cases

  • OpenAPI/Swagger documentation and UI integration for discoverable APIs.
  • Standardized REST conventions with versioned endpoints and RFC 7807 error handling.
  • Pagination, filtering, and sorting support with robust DTO and mapping strategies.
  • Content negotiation across JSON/XML with optional HAL/HATEOAS hypermedia support.
  • Easy integration with Spring Boot 3.x, security, and modular architecture.

Quick Start

Initialize a Spring Boot project and expose a REST API with OpenAPI documentation.

Frequently Asked Questions about spring-rest-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add OpenAPI and Swagger documentation to a Spring Boot REST API?

To add OpenAPI and Swagger to a Spring Boot REST API, you integrate documentation generation directly into your endpoints. This provides a discoverable UI and standardized API specs for your public microservices or internal backends.

What is the best way to implement pagination and sorting in a Spring REST API?

The best way to implement pagination and sorting in a Spring REST API is using standardized REST conventions with robust DTO mapping strategies. This ensures efficient data chunking and filtering for large enterprise backends.

How does HATEOAS hypermedia work in a Spring Boot application?

HATEOAS hypermedia in a Spring Boot application works by including hyperlinks in your API responses, guiding clients on available actions. It integrates with content negotiation across JSON and XML formats using optional HAL support.

Can I use RFC 7807 error handling and API versioning with Spring Boot 3.x?

Yes, you can use RFC 7807 error handling and API versioning with Spring Boot 3.x. This approach standardizes error responses and manages endpoint changes for production-ready internal APIs and microservices.

How do I configure content negotiation and CORS for a Spring RESTful API?

To configure content negotiation and CORS for a Spring RESTful API, you apply core patterns that support JSON/XML responses and cross-origin requests. This enables modular architecture and easy integration with security setups.