What pagination method is used?

It uses an offset/limit based pagination system where both the request and response follow a strict structural template.

Is security covered in these conventions?

Yes, the conventions include Bearer Token authentication, HTTPS requirements, and Rate Limiting response handling (429 Too Many Requests).

What naming conventions does this skill recommend?

The skill enforces kebab-case for URL paths, snake_case for JSON fields and query parameters, and UPPER_SNAKE_CASE for error codes.

Does this skill support API versioning?

Yes, it recommends URL path-based versioning (e.g., /api/v1/) and provides policies for handling breaking changes.

How are API errors structured?

Errors use a standardized JSON format containing a code, a message, and an optional details array specifically for validation errors.

RESTful API Convention Guide

Name: RESTful API Convention Guide
Author: iamhoonse-dev

byiamhoonse-dev

0•

API Development

Enforces standardized RESTful API design patterns for consistent URL structures, HTTP methods, and error handling.

This skill provides a comprehensive framework for designing professional RESTful APIs, ensuring consistency across backend services. It defines strict rules for URL resource naming using plural nouns and kebab-case, maps HTTP methods to specific CRUD actions with idempotency in mind, and establishes unified JSON response and error structures. By following these conventions, developers can create predictable, scalable, and well-documented APIs that are easy to integrate and maintain, while also incorporating security best practices such as Bearer Token authentication and Rate Limiting.

Key Features

01API versioning strategies and security implementation guidelines (HTTPS, Rate Limiting)

020 GitHub stars

03Standardized URL naming and resource hierarchy using plural nouns and kebab-case

04Unified JSON response formats for single resources, lists, and validation errors

05Standardized pagination, filtering, and sorting via query parameters

06Comprehensive HTTP status code mapping for success and error scenarios

Use Cases

01Designing a new backend service architecture with industry-standard REST patterns

02Refactoring legacy APIs to improve consistency and developer experience

03Establishing a unified API style guide for teams working on microservices

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add iamhoonse-dev/hoonse-claude-plugins api-convention

For use in Claude.ai and ChatGPT

Key Features

01API versioning strategies and security implementation guidelines (HTTPS, Rate Limiting)

020 GitHub stars

03Standardized URL naming and resource hierarchy using plural nouns and kebab-case

04Unified JSON response formats for single resources, lists, and validation errors

05Standardized pagination, filtering, and sorting via query parameters

06Comprehensive HTTP status code mapping for success and error scenarios

Use Cases

01Designing a new backend service architecture with industry-standard REST patterns

02Refactoring legacy APIs to improve consistency and developer experience

03Establishing a unified API style guide for teams working on microservices

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add iamhoonse-dev/hoonse-claude-plugins api-convention

For use in Claude.ai and ChatGPT