What industry standards does this skill follow?

This skill leverages battle-tested patterns from companies like Stripe, GitHub, Twilio, and Shopify, as well as the Microsoft REST API Guidelines.

Why is nesting depth limited to 2 levels?

Limiting nesting to 2 levels (e.g., /users/{id}/orders) improves readability, reduces coupling, and enhances cacheability compared to deep hierarchies.

Does it support both snake_case and camelCase?

While it prioritizes the modern industry standard of snake_case for JSON fields and query parameters, it emphasizes consistency and picking one convention to apply everywhere.

How does the skill handle non-CRUD actions like 'cancel'?

It recommends 'Action Endpoints' using the pattern POST /resource/{id}/verb, which is the standard approach for complex state transitions in resource-oriented APIs.

Can this skill help with naming boolean and date fields?

Yes, it provides specific prefixes for booleans (is_, has_, can_) and suffixes for timestamps (_at) or dates (_on) to ensure clarity.

API Route & Naming Standards

Name: API Route & Naming Standards
Author: oborchers

byoborchers

•

API開発

Standardizes API design using battle-tested URL structures and naming conventions based on industry leaders like Stripe and GitHub.

This skill provides specialized guidance for designing robust, intuitive RESTful APIs by enforcing proven industry standards. It helps developers move away from ambiguous naming by implementing resource-oriented URL patterns, enforcing shallow nesting limits, and maintaining strict case consistency across paths and JSON fields. By drawing on real-world patterns from top-tier platforms, it ensures your API remains scalable, cacheable, and easy for third-party developers to integrate without a steep learning curve.

主な機能

01Consistent case conventions (kebab-case, snake_case, and Train-Case)

029 GitHub stars

03Standardized naming for boolean, timestamp, and enum fields

04Resource-oriented URL design using plural nouns and HTTP methods

05Nesting depth management to prevent complex, brittle hierarchies

06Pattern-based designs for non-CRUD action endpoints and filtering

ユースケース

01Designing a new RESTful API for a high-growth SaaS product

02Establishing a standardized JSON schema for microservices communication

03Refactoring legacy endpoints to improve developer experience and consistency

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add oborchers/fractional-cto routes-and-naming

For use in Claude.ai and ChatGPT

主な機能

01Consistent case conventions (kebab-case, snake_case, and Train-Case)

029 GitHub stars

03Standardized naming for boolean, timestamp, and enum fields

04Resource-oriented URL design using plural nouns and HTTP methods

05Nesting depth management to prevent complex, brittle hierarchies

06Pattern-based designs for non-CRUD action endpoints and filtering

ユースケース

01Designing a new RESTful API for a high-growth SaaS product

02Establishing a standardized JSON schema for microservices communication

03Refactoring legacy endpoints to improve developer experience and consistency

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add oborchers/fractional-cto routes-and-naming

For use in Claude.ai and ChatGPT