skills.rest
TriNgo0108
TriNgo0108COMMUNITY
Explore all skills by this author →
GitHub

api-design-principles

Guide REST and GraphQL API design with patterns and checklists.

Updated Aug 23, 2026
Search Tags:#best practices#api design#rest#developer experience#graphql#api patterns
One-click install
npx skills add https://github.com/TriNgo0108/z-command --skill api-design-principles-tringo0108
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/TriNgo0108/z-command/tree/main/templates/skills/api-design-principles
Command: npx skills add https://github.com/TriNgo0108/z-command --skill api-design-principles-tringo0108

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps developers design, review, and improve RESTful and GraphQL APIs by providing best practices, patterns, and checklists, ensuring APIs are intuitive, scalable, and maintainable.

Core Features & Use Cases

  • API Design Standards: Learn and apply RESTful principles (resource-oriented, HTTP methods) and GraphQL principles (schema-first, queries/mutations).
  • Pattern Implementation: See practical examples of pagination, filtering, error handling, and versioning for both REST and GraphQL.
  • Use Case: When starting a new microservice with a REST API, use this Skill to ensure your endpoints follow established best practices for resource naming, HTTP methods, and status codes, leading to a more consistent and developer-friendly experience.

Quick Start

Review the API design checklist to ensure all best practices are followed for the new API.

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 API design and resource-oriented architecture?▼

REST API design best practices involve resource-oriented architecture, proper HTTP method semantics, standard status codes, and HATEOAS for navigation to build intuitive, scalable, and maintainable endpoints.

How do I implement pagination, filtering, and error handling in GraphQL APIs?▼

For GraphQL APIs, implement pagination, filtering, and error handling using schema-first development, structured query patterns, and DataLoader patterns to optimize data fetching and ensure maintainable schemas.

What's the best way to establish API versioning strategies for microservices?▼

API versioning strategies for microservices should be established by applying consistent resource naming, HTTP semantics for REST, or schema evolution for GraphQL, ensuring backward compatibility and developer experience.

How do I review and improve existing API endpoints using a design checklist?▼

Review existing API endpoints using a design checklist to validate resource naming, HTTP method semantics, error handling, and pagination patterns, ensuring the API meets established standards for developer experience.

When should I choose GraphQL schema-first development over RESTful principles?▼

Choose GraphQL schema-first development when clients need flexible query structures and DataLoader patterns, whereas RESTful principles suit resource-oriented architectures requiring standard HTTP method semantics and caching.

Why does inconsistent API design cause poor developer experience and how to fix it?▼

Inconsistent API design causes poor developer experience by lacking standard HTTP semantics, error handling, and pagination. Fix it by applying resource-oriented architecture and schema-first patterns to ensure maintainability.

Related Skills

Explore More Software Engineering Skills→
tinkermonkeytinkermonkey

LAYER_07_DATA_MODEL

Define and validate object data structures using JSON Schema Draft 7.

Community
Advanced
ChenYCLChenYCL

api-docs

Generate API documentation and OpenAPI 3.0 specs from code or descriptions.

Community
Intermediate
uxnameuxname
30

add-e2e-test

Create end-to-end tests for REST controllers and GraphQL resolvers with Fastify injection.

Community
Intermediate
HeldinhowHeldinhow
4

grpc-microservices

Enable gRPC communication between microservices using Protocol Buffers.

Community
Advanced