How does this skill handle naming conventions?

It enforces lower_snake_case for JSON fields, kebab-case for URI paths, and UPPER_SNAKE_CASE for enums, ensuring a consistent developer experience across your entire API surface.

Does it support OpenAPI specification validation?

Yes, the skill includes specialized validation scripts to check OpenAPI files for structural integrity, naming compliance, and adherence to enterprise standards.

What error format does this skill recommend?

It strictly adheres to the RFC 9457 Problem Details format for all error responses, ensuring that error messages are descriptive, standardized, and machine-readable.

Can I use this for reviewing existing APIs?

Absolutely. You can provide an existing OpenAPI spec or endpoint description, and the skill will perform a thorough review against best practices, highlighting areas for improvement.

Does it help with API versioning strategies?

Yes, it provides guidance on URI-based major versioning and outlines strict rules for backward compatibility, deprecation headers, and sunsetting old versions.

API Design & Review

Name: API Design & Review
Author: cameronsjo

bycameronsjo

•

Desarrollo de API

Provides expert guidance and automated validation for designing, reviewing, and standardizing enterprise-grade RESTful APIs and OpenAPI specifications.

This skill empowers developers to build consistent and robust RESTful interfaces by enforcing industry best practices and enterprise standards. It covers everything from resource modeling and URI hierarchy to strict naming conventions, RFC 9457 compliant error handling, and semantic versioning. Whether you are drafting a new OpenAPI specification or auditing an existing codebase for compliance, this skill provides actionable feedback, automated validation scripts, and templates to ensure a high-quality developer experience and seamless API integration.

Características Principales

011 GitHub stars

02Expert RESTful resource modeling and URI hierarchy design guidance

03Automated naming convention validation for fields, paths, and enums

04Standardized RFC 9457 error handling and status code mapping

05Comprehensive OpenAPI specification review and compliance checking

06Generation of common types and cursor-based pagination schemas

Casos de Uso

01Automating schema validation and naming checks for legacy API migrations

02Conducting a comprehensive design review of an existing API for enterprise compliance

03Designing a new microservice API from scratch using OpenAPI 3.0

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add cameronsjo/claude-marketplace api-design

For use in Claude.ai and ChatGPT

Download Skill