Does it support API versioning?

Yes, it recommends URL-based versioning as the primary strategy and includes guidelines for deprecation headers and migration periods.

How are API errors structured with this skill?

Errors follow a standardized JSON format including the HTTP status, error type, a clear message, timestamp, and an optional array of specific validation details.

What naming conventions does this skill follow for URLs?

The skill enforces kebab-case for paths, plural nouns for resource identification, and nested sub-resources to represent logical data relationships.

What standards are used for date and time fields?

All date and time fields are formatted using the ISO 8601 standard (e.g., 2024-01-15T10:30:00Z) to ensure global compatibility.

REST API Design Standards

Name: REST API Design Standards
Author: tymoj

bytymoj

0•

API Development

Standardizes RESTful API development through industry-leading naming conventions, response patterns, and documentation best practices.

This skill provides Claude with a comprehensive set of architectural guidelines for building robust and scalable REST APIs. It ensures consistency across backend services by enforcing strict patterns for URL structure (kebab-case, plural nouns), HTTP method usage, and standardized JSON response formats. By implementing these conventions, developers can ensure their APIs are intuitive, secure, and compatible with modern web standards, making it an essential tool for initial design phases, creating OpenAPI documentation, or performing architectural code reviews.

Key Features

01Uniform JSON formatting with camelCase fields and ISO 8601 dates

02Standardized URL naming conventions using kebab-case and plural nouns

03Structured pagination, filtering, and sorting query strategies

04Consistent HTTP method mapping and status code responses

050 GitHub stars

06Security-first design principles including input validation and ID protection

Use Cases

01Refactoring legacy API routes to follow modern architectural standards

02Generating or reviewing OpenAPI/Swagger documentation for consistency

03Designing new RESTful endpoints and DTOs from scratch

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add tymoj/marketplace rest-api-design

For use in Claude.ai and ChatGPT