api-design-reviewer

Review RESTful API designs for naming, methods, and error formats.

5|Updated Feb 26, 2026
One-click install
npx skills add https://github.com/lidge-jun/cli-jaw-skills --skill api-design-reviewer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design-reviewer
Source: https://github.com/lidge-jun/cli-jaw-skills/tree/main/api-design-reviewer
Command: npx skills add https://github.com/lidge-jun/cli-jaw-skills --skill api-design-reviewer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps developers and architects design and review REST APIs, ensuring they adhere to industry best practices for naming, methods, error handling, and more, preventing common pitfalls and improving API quality.

Core Features & Use Cases

  • RESTful Design Principles: Guides on resource naming, HTTP method usage, and URL structure.
  • Error Handling & Versioning: Provides standard formats for error responses and strategies for API versioning.
  • Use Case: When designing a new /users endpoint, use this Skill to verify that you are using plural nouns, appropriate HTTP methods (GET, POST, PUT, DELETE), and a consistent error response format.

Quick Start

Review the API design for the /products endpoint, ensuring it follows REST best practices.

Frequently Asked Questions about api-design-reviewer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review my RESTful API design for best practices?

To review a RESTful API for best practices, check resource naming conventions, HTTP method usage, pagination patterns, and error response formats. This ensures your web services maintain consistency and avoid common anti-patterns.

What is the correct way to name REST API resources and endpoints?

Correct REST API resource naming uses plural nouns for endpoints, such as `/users` or `/products`. This approach aligns with industry best practices for web services, ensuring consistent URL structure and predictable API interactions.

How should I structure error responses in my REST API?

REST API error responses should use standardized formats to ensure maintainability and developer experience. Implementing consistent error handling prevents common API anti-patterns and helps developers quickly identify and resolve issues.

What are the best strategies for REST API versioning, rate limiting, and authentication?

The best strategies for REST API versioning, rate limiting, and authentication involve implementing standardized versioning patterns, defining rate limits, and selecting appropriate authentication methods to ensure robust API development and security.

Why does my REST API have inconsistent pagination and HTTP method usage?

Inconsistent pagination and HTTP method usage in a REST API usually indicates a deviation from best practices. Adopting proper pagination patterns and correct HTTP methods like GET, POST, PUT, and DELETE resolves these common anti-patterns.