Skills
.Work. You
Rest

rest-api-conventions

Community

Standardize REST API patterns in Spring Boot.

Software Engineering#error-handling#spring-boot#pagination#api-design#rest-api#http-status
Authorrrezartprebreza
Version1.0.0
Installs0

System Documentation

What problem does it solve?

REST API development in Spring Boot often suffers from inconsistent response shapes, scattered error handling, and ad-hoc pagination. This Skill defines a single standard: a response envelope, a uniform ApiResponse/ApiError model, predictable HTTP status mappings, and versioned URLs.

Core Features & Use Cases

  • Unified response envelope for all endpoints with fields: success, data, error, and timestamp.
  • Centralized error handling via a GlobalExceptionHandler and ApiError definitions.
  • Consistent pagination and URL conventions, including versioned paths and UUIDs in IDs.
  • Use Case: Aligns new and existing services to the same contract, improving client integration and error diagnosis.

Quick Start

Apply the ApiResponse wrapper and GlobalExceptionHandler to your Spring Boot project to start enforcing REST API conventions.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: rest-api-conventions
Download link: https://github.com/rrezartprebreza/spring-boot-skills/archive/main.zip#rest-api-conventions

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 510,000+ vetted skills library on demand.