skills.rest
j7-dev
j7-devCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-design

Guide REST API design covering resource naming, HTTP methods, status codes, and response formats.

19|4|Updated Mar 1, 2026
Search Tags:#api design#rest#backend development#web services#api best practices#resource naming
One-click install
npx skills add https://github.com/j7-dev/everything-github-copilot --skill api-design-j7-dev
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/j7-dev/everything-github-copilot/tree/main/.agents/skills/api-design
Command: npx skills add https://github.com/j7-dev/everything-github-copilot --skill api-design-j7-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides comprehensive guidance on designing production-ready REST APIs, ensuring consistency, usability, and adherence to best practices.

Core Features & Use Cases

  • Resource Naming & URL Structure: Defines conventions for clear and intuitive API endpoints.
  • HTTP Methods & Status Codes: Details the semantic use of HTTP verbs and appropriate status codes for various scenarios.
  • Response Formatting: Offers patterns for success, collection, and error responses, including pagination.
  • Filtering, Sorting, and Versioning: Outlines strategies for flexible data retrieval and API evolution.
  • Use Case: When designing a new /users endpoint, use this Skill to ensure proper resource naming, implement pagination for lists, and define a clear error response structure for validation failures.

Quick Start

Use the api-design skill to generate a plan for designing a new user management API.

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 REST API resource naming and URL structure?▼

REST API resource naming conventions use clear, intuitive nouns for endpoints. This skill provides detailed guidance on defining URL structures that ensure API consistency and maintainability across your web services.

How do I implement pagination, filtering, and sorting in a REST API?▼

To implement pagination, filtering, and sorting in a REST API, define flexible data retrieval strategies for collection responses. This skill outlines patterns for structuring query parameters to manage large datasets effectively.

Which HTTP methods and status codes should I use for backend development?▼

Use semantic HTTP methods and appropriate status codes for backend development. This skill details the correct application of HTTP verbs and status codes for various scenarios to build robust web services.

How should I structure error responses and format success responses in REST APIs?▼

Structure error responses and format success responses in REST APIs using standardized patterns. This skill offers formatting guidance for success, collection, and error outputs to handle validation failures clearly.

What is the best way to handle API versioning and authentication?▼

The best way to handle API versioning and authentication is to establish clear evolution and security strategies. This skill outlines methods for versioning endpoints and implementing authentication protocols.

Related Skills

Explore More Software Engineering Skills→
jinwoonghongjinwoonghong

moai-domain-backend

Design REST or GraphQL APIs with authentication and database integration.

Community
Advanced
HouseGarofaloHouseGarofalo
3

openapi-swagger

Design, document, and generate APIs from OpenAPI and Swagger specifications.

Official
Advanced
felvieirafelvieira
22

backend-api

Define API contracts and data models for Node.js backend applications.

Community
Advanced
Ayub-KhanAyub-Khan

api-design

Design REST, GraphQL, gRPC, and WebSocket APIs with resource modeling and versioning.

Community
Advanced