skills.rest
B4san
B4sanCOMMUNITY
Explore all skills by this author →
GitHub

api-design-principles

Design REST and GraphQL APIs with resource-oriented architecture and HTTP semantics.

Updated Feb 19, 2026
Search Tags:#best practices#api design#rest#developer experience#graphql#api patterns
One-click install
npx skills add https://github.com/B4san/Calix-Pass --skill api-design-principles-b4san
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/B4san/Calix-Pass/tree/main/.gemini/skills/api-design-principles
Command: npx skills add https://github.com/B4san/Calix-Pass --skill api-design-principles-b4san

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps developers design, review, and standardize intuitive, scalable, and maintainable APIs by providing comprehensive principles and patterns for both REST and GraphQL.

Core Features & Use Cases

  • API Design Guidance: Offers best practices for RESTful resource-oriented design, HTTP methods, and status codes.
  • GraphQL Patterns: Details schema design, resolver patterns, and N+1 problem prevention.
  • Use Case: When designing a new microservice API, use this Skill to ensure adherence to industry best practices for consistency and developer experience.

Quick Start

Review the RESTful design principles for creating a new user endpoint.

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

REST API design best practices involve resource-oriented architecture, correct HTTP semantics, standard status codes, and HATEOAS to build intuitive and maintainable endpoints. This Skill provides comprehensive principles to help you standardize RESTful resources.

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

To design a GraphQL schema and prevent the N+1 problem, you should apply specific resolver patterns and schema-first development principles. This Skill details GraphQL patterns to optimize data fetching and ensure scalable API architectures.

Should I use REST or GraphQL for my new microservice API?▼

Choosing between REST and GraphQL for a microservice API depends on your data fetching needs and developer experience goals. This Skill compares RESTful resource-oriented design with GraphQL schema patterns to help you establish the right API standards.

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

Handling pagination, filtering, and error handling in APIs requires implementing consistent design patterns across your endpoints. This Skill offers guidance on standardizing these strategies to maintain scalable and intuitive API specifications.

What versioning strategies should I use when reviewing API specifications?▼

Versioning strategies for reviewing API specifications ensure backward compatibility and maintainability as your endpoints evolve. This Skill covers standard versioning approaches to help you establish robust API design standards.

Related Skills

Explore More Software Engineering Skills→
musujmusuj

phase-1-schema

Define project terminology, entities, relationships, and data structures.

Community
Intermediate
lamb92009lamb92009

api-designer

Design REST and GraphQL APIs and generate OpenAPI 3.1 specifications.

Community
Advanced
AcczdyAcczdy
2

implementing-api-abuse-detection-with-rate-limiting

Implement API abuse detection with token bucket, sliding window, and adaptive rate limiting on Redis.

Community
Advanced
berkcangumusisikberkcangumusisik
11

openapi-gen

Generate OpenAPI 3.0 specifications from TypeScript Express-like route definitions.

Community
Intermediate