skills.rest
AaronZhou-THU
AaronZhou-THUCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Design REST and GraphQL APIs with authentication, pagination, and OpenAPI specifications.

Updated Mar 11, 2026
Search Tags:#versioning#authentication#openapi#rest#graphql#pagination#api-design
One-click install
npx skills add https://github.com/AaronZhou-THU/OpenAgent --skill api-design-aaronzhou-thu
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/AaronZhou-THU/OpenAgent/tree/main/agent-api/src/agent_service/data/skills/api-design
Command: npx skills add https://github.com/AaronZhou-THU/OpenAgent --skill api-design-aaronzhou-thu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Design and implement production-quality APIs. Covers REST conventions, authentication, pagination, error handling, OpenAPI specifications, and framework-specific patterns.

Core Features & Use Cases

  • Resource naming and endpoint design for REST APIs
  • HTTP methods, status codes, and standard response envelopes
  • Pagination strategies, query parameters, and sorting
  • OpenAPI/Swagger specification integration and versioning guidelines
  • Authentication, authorization, rate limiting, errors handling best practices
  • Framework-specific patterns for FastAPI, Express, and Django
  • Real-world use case: building a versioned user service with CRUD and robust error handling

Quick Start

Use the api-design skill to scaffold a production-ready API with versioned endpoints and standard CRUD operations.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design pagination and error handling for REST APIs?▼

REST API design for pagination and error handling requires standard response envelopes and consistent HTTP status codes. This involves applying pagination strategies, query parameters, and structured error formats to ensure predictable collection endpoints.

What's the best way to structure API versioning and OpenAPI specifications?▼

API versioning and OpenAPI specifications are best structured through strict versioning discipline and integrated Swagger documentation. This ensures clear endpoint evolution tracking and automated, up-to-date contract generation for consumers.

Can I use FastAPI, Express, or Django for production-grade API development?▼

FastAPI, Express, and Django are fully supported for production-grade API development. Framework-specific patterns are applied to implement authentication, rate limiting, and standard CRUD operations across both REST and GraphQL architectures.

How do I implement authentication and rate limiting in GraphQL APIs?▼

Authentication and rate limiting in GraphQL APIs are implemented by enforcing authorization rules and consistent response envelopes across queries. This approach secures endpoints while maintaining standard modeling conventions and input validation.

Why do my API endpoints need consistent response envelopes and input validation?▼

API endpoints need consistent response envelopes and input validation to ensure reliable client interactions and robust error handling. Enforcing these practices prevents data inconsistency and standardizes single-resource and collection endpoint outputs.

Related Skills

Explore More Software Engineering Skills→
samjhechtsamjhecht
4

initialize-governance

Generate Constitution, Roadmap, and process documentation templates for project governance.

Community
Advanced
jhlee0409jhlee0409
4

openapi-parser

Parse OpenAPI 3.x and Swagger 2.0 specs into structured endpoint catalogs.

Community
Advanced
xu-xiangxu-xiang
1.8k

django-security

Enforce authentication, authorization, and secure Django settings.

Community
Intermediate
roanbrasilroanbrasil
5

api-gateway-design

Configure API gateways with authentication, rate limiting, and routing.

Community
Advanced