api-design-principles

Guide REST and GraphQL API design with resource modeling and versioning.

Updated Jan 9, 2025

Search Tags:#api design #rest #developer experience #graphql #api architecture #api standards

Ready to run

npx skills add https://github.com/baotoq/go-shortener --skill api-design-principles-baotoq

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/baotoq/go-shortener/tree/main/.agents/skills/api-design-principles
Command: npx skills add https://github.com/baotoq/go-shortener --skill api-design-principles-baotoq

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps developers and architects design and build intuitive, scalable, and maintainable APIs by adhering to established REST and GraphQL design principles.

Core Features & Use Cases

API Design Guidance: Provides best practices for resource modeling, endpoint design, and data fetching.
Standardization: Helps establish consistent API design standards across teams.
Use Case: When designing a new microservice API, use this Skill to ensure the API is well-structured, easy to understand, and follows industry best practices for both REST and GraphQL.

Quick Start

Use the api-design-principles skill to review the proposed API specification for consistency and adherence to best practices.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema

What are the best practices for REST and GraphQL API resource modeling?▼

REST and GraphQL API resource modeling best practices involve structuring endpoints and schemas for scalability. This guidance covers endpoint design and data fetching to ensure APIs are well-structured and easy to understand.

How do I design consistent API versioning and error handling standards?▼

Design consistent API versioning and error handling by applying established design principles. This ensures standardized API contracts across teams, facilitating the creation of developer-friendly and maintainable services.

How do I optimize API performance with pagination and mutation patterns?▼

Optimize API performance with pagination and mutation patterns by following architectural best practices. This guidance emphasizes efficient schema design and mutation handling for both REST and GraphQL APIs.

When should I use GraphQL versus REST for my microservice API architecture?▼

Choosing GraphQL versus REST for microservice API architecture depends on your data fetching needs. This guidance provides best practices for both architectural styles to help you build scalable and maintainable API contracts.

Can I use this API design guidance to review an existing API specification?▼

Yes, you can use this API design guidance to review an existing API specification. It helps check your proposed specifications for consistency and adherence to industry best practices for both REST and GraphQL.