java-api-design-rest
CommunityDesign robust REST APIs with OpenAPI contracts.
Software Engineering#openapi#rest#pagination#contract-first#api-design#error-model#controller-contracts
AuthorHZeroxium
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill enables teams to design consistent REST APIs with clear resource modeling, robust pagination/filtering, a standardized error model, and versioning guidelines, while producing an OpenAPI draft and implementation contracts (controllers/service interfaces) for backend work.
Core Features & Use Cases
- Resource modeling (nouns, hierarchies, relationships) and explicit endpoint semantics (GET/POST/PUT/PATCH/DELETE) with idempotency guidance.
- Pagination, filtering, and sorting patterns and response shapes, plus stable error handling using RFC 9457 Problem Details.
- Versioning strategy and backward-compatible changes, along with producing an OpenAPI draft and contract definitions for controllers and services.
Quick Start
Design a complete REST API plan for a new endpoint, including resources, endpoints, pagination, errors, and an OpenAPI draft.
Dependency Matrix
Required Modules
None requiredComponents
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: java-api-design-rest Download link: https://github.com/HZeroxium/cursorkit/archive/main.zip#java-api-design-rest Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.