skills.rest
jonico22
jonico22COMMUNITY
Explore all skills by this author →
𝕏@jonico22GitHub

api-design-principles

Guide RESTful and GraphQL API design with resource-oriented architecture and schema patterns.

Updated Jun 19, 2025
Search Tags:#api design#rest#developer experience#graphql#software architecture#api best practices
One-click install
npx skills add https://github.com/jonico22/api_business_jke --skill api-design-principles-jonico22
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/jonico22/api_business_jke/tree/main/.agents/skills/api-design-principles
Command: npx skills add https://github.com/jonico22/api_business_jke --skill api-design-principles-jonico22

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

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

Core Features & Use Cases

  • RESTful Design: Master resource-oriented architecture, HTTP method semantics, and common patterns like pagination and error handling.
  • GraphQL Design: Understand schema-first development, query structure, and patterns like DataLoader for efficient data fetching.
  • Use Case: When starting a new microservice, use this Skill to ensure your API adheres to best practices for discoverability, usability, and long-term maintainability.

Quick Start

Use the api-design-principles skill to review the RESTful design principles for resource collection design.

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 RESTful API resource collection design?▼

Best practices for RESTful API resource design involve applying resource-oriented architecture, using correct HTTP method semantics, and implementing standard patterns for pagination and error handling to ensure discoverability and maintainability.

How do I design a GraphQL schema for efficient data fetching?▼

To design a GraphQL schema for efficient data fetching, adopt schema-first development, structure queries properly, and apply patterns like DataLoader to batch requests and optimize performance.

How do I handle API versioning and error handling in a microservice architecture?▼

Handling API versioning and error handling in a microservice architecture requires applying established REST and GraphQL design principles to maintain long-term usability, clear error responses, and intuitive developer experience.

Should I choose REST or GraphQL for my new software architecture?▼

Choosing between REST and GraphQL depends on your software architecture needs: REST provides resource-oriented architecture with standard HTTP semantics, while GraphQL offers schema-first development and efficient data fetching patterns for complex queries.

Can I use these API design principles to improve developer experience and scalability?▼

You can use these API design principles to improve developer experience and scalability by applying comprehensive RESTful and GraphQL patterns, schema design, versioning, and performance optimization techniques.

Related Skills

Explore More Software Engineering Skills→
saffron-healthsaffron-health
862

generate-spec

Generate phased specification documents from code and documentation analysis.

Official
Advanced
hffmnnjhffmnnj
39

api-docs

Generate API reference documentation from OpenAPI specs and GraphQL schemas.

Community
Advanced
Claude-Code-Community-IrelandClaude-Code-Community-Ireland
10

api-testing-observability-api-mock

Generate mock API services with configurable responses, errors, and latency.

Official
Intermediate
htayjhtayj

add-rest-endpoint

Automate REST API endpoint creation with schema design, routing, handlers, tests, and documentation.

Community
Intermediate