api-design-principles

Review REST and GraphQL API specifications using design checklists.

10|3|Updated Mar 14, 2025

Search Tags:#api design #rest #developer experience #graphql #api development #software architecture

Ready to run

npx skills add https://github.com/Mentor-Wizard/mentor-wizard-webapp --skill api-design-principles-mentor-wizard

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/Mentor-Wizard/mentor-wizard-webapp/tree/main/.claude/skills/api-design-principles
Command: npx skills add https://github.com/Mentor-Wizard/mentor-wizard-webapp --skill api-design-principles-mentor-wizard

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) and references (resource) components.

What problem does it solve?

This Skill helps you design and build intuitive, scalable, and maintainable APIs that are easy for developers to use and understand.

Core Features & Use Cases

REST & GraphQL Design: Master principles for both RESTful and GraphQL APIs.
API Review & Standards: Use it to review API specifications or establish design standards for your team.
Use Case: When designing a new microservice API, use this Skill to ensure your endpoints are well-structured, versioned correctly, and provide clear error messages, making integration smoother for other teams.

Quick Start

Use the api-design-principles skill to generate a checklist for reviewing a new REST API specification.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema

How do I design intuitive and scalable REST APIs for microservices?▼

Design intuitive REST APIs by structuring endpoints logically, implementing correct versioning, and providing clear error messages to ensure smooth integration and long-term maintainability for your microservices.

What principles should I follow for GraphQL API development and design standards?▼

Follow GraphQL API development principles prioritizing developer experience and scalability, utilizing established design standards and checklists to review specifications and ensure your schema remains maintainable.

Can I use this to review an existing API specification for maintainability?▼

Yes, you can review existing API specifications for maintainability by generating a practical checklist that evaluates endpoint structure, versioning, and error handling against established design standards.

What is the best way to establish API design standards for a software engineering team?▼

Establish API design standards by utilizing playbooks and checklists that enforce intuitiveness and scalability principles, ensuring consistent developer experience across both REST and GraphQL implementations.

How do I ensure my API endpoints provide clear error messages and smooth integration?▼

Ensure API endpoints provide clear error messages and smooth integration by applying design principles focused on developer experience, validating your specification structure through dedicated review playbooks.