skills.rest
FernaandoJr
FernaandoJrCOMMUNITY
Explore all skills by this author →
Website𝕏@fernaandojrdevGitHub

api-design-principles

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

Updated Sep 8, 2025
Search Tags:#schema design#api design#rest#developer experience#graphql#api best practices
One-click install
npx skills add https://github.com/FernaandoJr/oikwee --skill api-design-principles-fernaandojr
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/FernaandoJr/oikwee/tree/main/.agents/skills/api-design-principles
Command: npx skills add https://github.com/FernaandoJr/oikwee --skill api-design-principles-fernaandojr

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 by providing best practices and patterns for both REST and GraphQL.

Core Features & Use Cases

  • API Design Standards: Establish clear guidelines for your team.
  • RESTful Principles: Learn resource-oriented design, HTTP method semantics, and common patterns like pagination and error handling.
  • GraphQL Principles: Master schema design, resolver patterns, and N+1 problem prevention.
  • Use Case: When designing a new microservice API, use this Skill to ensure it adheres to industry best practices for both REST and GraphQL, making it easier for other developers to consume and integrate with.

Quick Start

Review the RESTful Design Principles section to understand resource-oriented endpoints.

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-oriented design?▼

RESTful API design best practices involve using resource-oriented architecture, correct HTTP method semantics, and standard patterns for pagination and error handling to build intuitive endpoints. This ensures your services remain scalable and maintainable.

How do I design a GraphQL schema to prevent the N+1 problem?▼

To design a GraphQL schema that prevents the N+1 problem, you should apply specific resolver patterns and best practices for schema design. This approach optimizes data fetching and ensures your GraphQL API performs efficiently.

Should I choose REST or GraphQL when designing a new microservice API?▼

Choosing between REST and GraphQL for a microservice API depends on your data fetching needs. REST provides resource-oriented architecture with clear HTTP semantics, while GraphQL offers flexible schema design and resolver patterns for complex data queries.

How do I establish API design standards for my development team?▼

You can establish API design standards by applying comprehensive guidelines covering RESTful principles, GraphQL schema design, API versioning, and error handling. This creates clear, consistent patterns for developers building new services.

What is the best way to handle API versioning and error handling?▼

The best way to handle API versioning and error handling is to follow established industry patterns for both REST and GraphQL. Implementing structured error responses and clear versioning strategies ensures your API remains maintainable over time.

Related Skills

Explore More Software Engineering Skills→
botPhUbotPhU

rest-api-expert

Design REST APIs with versioning, error handling, and OpenAPI specs.

Community
Advanced
belokonmbelokonm
8

api-designer

Design REST and GraphQL APIs and generate OpenAPI 3.1 specifications.

Community
Advanced
weirdgmeweirdgme
4

api-engineering

Automate API design and governance with REST, GraphQL, and gRPC best practices.

Community
Advanced
bswrundquistbswrundquist

openapi

Design and document RESTful APIs using the OpenAPI 3.x specification.

Community
Intermediate