skills.rest
cenjie
cenjieCOMMUNITY
Explore all skills by this author →
GitHub

rest-api-design

Design RESTful APIs with resource modeling, HTTP methods, and OpenAPI documentation.

Updated May 17, 2026
Search Tags:#versioning#openapi#rest#pagination#api-design#http-status-codes#resource-modeling
One-click install
npx skills add https://github.com/cenjie/skills --skill rest-api-design-cenjie
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: rest-api-design
Source: https://github.com/cenjie/skills/tree/main/skills/rest-api-design
Command: npx skills add https://github.com/cenjie/skills --skill rest-api-design-cenjie

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Provides a clear, opinionated framework for modeling resources, endpoints, and behaviors so APIs are consistent, maintainable, and easy for clients to consume.

Core Features & Use Cases

  • Resource modeling guidance using nouns and plural collection names to improve discoverability and consistency.
  • HTTP method and status code recommendations, pagination, filtering, sorting, and versioning patterns for robust client-server interactions.
  • Documentation and example artifacts including OpenAPI scaffolds and an Express.js complete example to accelerate implementation and review.

Quick Start

Create a REST API endpoint design for a user resource that includes list, retrieve, create, update, and delete operations using plural nouns and v1 URL path versioning.

Frequently Asked Questions about rest-api-design

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

FAQPage Schema
How do I design a REST API with consistent resource naming and HTTP methods?▼

Design REST API resources using plural nouns for collections and apply correct HTTP methods like GET, POST, PUT, and DELETE to ensure consistent client-server interactions and endpoint discoverability.

What HTTP status codes should I use for my REST API endpoints?▼

Use correct HTTP status codes to signal outcomes of REST API operations, ensuring robust client-server interactions by accurately representing success, client errors, or server errors during resource processing.

What is the best way to implement pagination and filtering in a REST API?▼

Implement pagination, filtering, and sorting patterns in your REST API to manage large datasets efficiently, allowing clients to request specific data subsets and maintain robust web service interactions.

How do I version my REST API endpoints using URL paths?▼

Version REST API endpoints using v1 URL path versioning patterns to manage changes over time, ensuring maintainability and preventing breaking changes for clients consuming your web service.

Can I use this to generate OpenAPI documentation for my REST API?▼

Yes, generate OpenAPI documentation scaffolds for your REST API to accelerate implementation and review, providing clear documentation artifacts for defined request and response schemas.

Does this REST API design guidance include authentication and rate limiting?▼

Yes, this REST API design guidance includes basic authentication and rate limiting headers to help backend engineers secure endpoints and manage client request volumes effectively.

Related Skills

Explore More Software Engineering Skills→
Olu-AnuAkin-AkinyemiOlu-AnuAkin-Akinyemi
1

api-design-architect

Design RESTful APIs with endpoint planning, authentication patterns, and OpenAPI documentation.

Community
Intermediate
rebyteai-templaterebyteai-template
15

express-mcp

Implement an MCP server with Express.js and TypeScript.

Official
Intermediate
Ankurjain1121Ankurjain1121

openapi-spec-generation

Convert API contracts into OpenAPI 3.1 specifications and SDK templates.

Community
Advanced
duylinhdang1998duylinhdang1998

graphql-expert

Design and implement type-safe GraphQL APIs with DataLoader batching and Relay pagination.

Community
Advanced