skills.rest
Leavesfly
LeavesflyCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Design RESTful APIs with resource-oriented URLs, HTTP methods, and status codes.

233|49|Updated Nov 4, 2025
Search Tags:#restful#api design#web services#http methods#api conventions#resource design
One-click install
npx skills add https://github.com/Leavesfly/Jimi --skill api-design-leavesfly
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/Leavesfly/Jimi/tree/main/src/main/resources/skills/api-design
Command: npx skills add https://github.com/Leavesfly/Jimi --skill api-design-leavesfly

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive guide to designing robust and maintainable RESTful APIs, ensuring consistency and adherence to industry best practices.

Core Features & Use Cases

  • Resource-Oriented Design: Learn to use nouns for resources and avoid verbs in URLs.
  • HTTP Method Usage: Understand the correct application of GET, POST, PUT, PATCH, and DELETE.
  • URL Structure Conventions: Follow best practices for creating clear and intuitive API endpoints.
  • Response Formatting: Implement consistent JSON responses with proper field naming and metadata.
  • Error Handling: Design effective error responses with clear codes and messages.
  • Status Code Best Practices: Utilize appropriate HTTP status codes for different scenarios.
  • API Versioning: Implement strategies for managing API evolution.
  • Use Case: A developer needs to design a new set of APIs for a microservice and wants to ensure they follow established RESTful conventions for clarity and ease of integration.

Quick Start

Consult the API design skill for guidance on using HTTP methods for resource actions.

Frequently Asked Questions about api-design

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

FAQPage Schema
What are the best practices for RESTful API resource design?▼

RESTful API resource design uses nouns instead of verbs in URLs to structure endpoints around resources. This approach ensures clear, intuitive, and maintainable web service interfaces for scalable integrations.

How do I use HTTP methods correctly for RESTful API actions?▼

Use HTTP methods like GET, POST, PUT, PATCH, and DELETE to perform specific actions on API resources. Proper method usage maps directly to standard CRUD operations, ensuring predictable and consistent API behavior.

How should I format JSON responses and handle errors in web services?▼

Format JSON responses with consistent field naming and metadata, while handling API errors using clear codes and messages. This ensures web service responses are predictable and easy for clients to parse.

What HTTP status codes should I return for different API scenarios?▼

Return appropriate HTTP status codes to indicate the outcome of API requests in different scenarios. Utilizing correct status codes is a core convention for designing maintainable and scalable RESTful interfaces.

What is the best way to implement API versioning for microservices?▼

Implement API versioning strategies to manage web service evolution and maintain backward compatibility. This is crucial for designing robust microservice APIs that change over time without breaking integrations.

Related Skills

Explore More Software Engineering Skills→
chapzinchapzin
1

Api Design

Define RESTful API designs with resource models, versioning, and error contracts.

Community
Intermediate
giuseppe-trisciuogliogiuseppe-trisciuoglio
322

spring-boot-openapi-documentation

Generate OpenAPI 3.0 documentation and Swagger UI for Spring Boot 3.x applications.

Community
Advanced
vishalsachdevvishalsachdev
2

secure-nextjs-api-routes

Secure Next.js 13+ App Router API routes with composable middleware.

Community
Advanced
alexfalkowskialexfalkowski
2

api-standards

Enforce resource-oriented API design and transport-specific conventions for gRPC, REST, and MVC contracts.

Community
Advanced