Is this specific to one programming language?

No, while the design principles are language-agnostic, the skill includes specific implementation examples for TypeScript (Next.js), Python (Django REST Framework), and Go.

Can this skill help with error handling?

Absolutely. It defines a standard error response envelope and maps semantic HTTP status codes—such as 422 for validation errors or 429 for rate limiting—to specific client scenarios.

Does it support different pagination methods?

Yes, it provides patterns for both simple offset-based pagination for small datasets/dashboards and scalable cursor-based pagination for large-scale production environments and infinite scrolls.

How does this skill help with API naming conventions?

It enforces the use of plural nouns, kebab-case for multi-word resources, and forbids the use of verbs in URLs, ensuring a clean and consistent RESTful structure.

API Design Best Practices

Name: API Design Best Practices
Author: nbossn

bynbossn

0•

API 开发

Standardizes RESTful API architecture with production-grade patterns for resource naming, status codes, and pagination.

This skill empowers Claude to design consistent, developer-friendly REST APIs by providing a comprehensive set of industry-standard conventions and implementation patterns. It covers every aspect of API development, from semantic URL structures and HTTP method usage to advanced concepts like cursor-based pagination, sparse fieldsets, and robust error handling envelopes. By incorporating these best practices, the skill ensures that your API contracts are scalable, predictable, and follow enterprise-grade security and versioning strategies across multiple backend languages including TypeScript, Python, and Go.

主要功能

01Dual-strategy pagination support for both offset-based and scalable cursor-based systems

020 GitHub stars

03Advanced filtering, sorting, and full-text search query parameter patterns

04Comprehensive versioning and rate-limiting headers for public-facing API lifecycle management

05Standardized URL resource naming using plural nouns and kebab-case conventions

06Semantic HTTP status code mapping for consistent client-side error handling

使用场景

01Implementing complex filtering and pagination for high-traffic data collections

02Architecting a new set of RESTful endpoints for a microservice or SaaS product

03Refactoring inconsistent API response formats to follow a standardized data envelope

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add nbossn/claude-code-base api-design

For use in Claude.ai and ChatGPT