skills.rest
HermeticOrmus
HermeticOrmusCOMMUNITY
Explore all skills by this author →
Website𝕏@dbodartmGitHub

api-design-principles

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

89|14|Updated Nov 15, 2025
Search Tags:#api design#rest#graphql#backend development#interface design#api best practices
One-click install
npx skills add https://github.com/HermeticOrmus/LibreUIUX-Claude-Code --skill api-design-principles-hermeticormus
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/HermeticOrmus/LibreUIUX-Claude-Code/tree/main/plugins/backend-development/skills/api-design-principles
Command: npx skills add https://github.com/HermeticOrmus/LibreUIUX-Claude-Code --skill api-design-principles-hermeticormus

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps you understand and apply best practices for designing robust and developer-friendly REST and GraphQL APIs, ensuring maintainability and scalability.

Core Features & Use Cases

  • RESTful Principles: Learn resource-oriented design, HTTP method semantics, and error handling.
  • GraphQL Principles: Understand schema design, query structure, and mutation patterns.
  • Best Practices: Covers versioning, pagination, filtering, and security.
  • Use Case: When designing a new microservice API, use this Skill to ensure you follow established patterns for resource naming, error responses, and pagination, making it easier for other developers to integrate with.

Quick Start

Review the RESTful design patterns for resource collection design and error handling.

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 naming and error handling?▼

RESTful API design best practices involve resource-oriented architecture, proper HTTP method semantics, and standardized error responses. This ensures backend interfaces remain intuitive, maintainable, and scalable for developers.

How do I design a GraphQL schema for mutations and queries?▼

Designing a GraphQL schema requires structuring queries and mutation patterns effectively. Following established schema design principles ensures your API handles data fetching efficiently while maintaining strict type safety.

REST vs GraphQL: which API design approach should I choose for my microservice?▼

Choosing between REST and GraphQL for an API depends on your data fetching needs. REST uses resource-oriented endpoints, while GraphQL offers flexible query structures, and both require distinct design patterns for scalability.

How do I implement pagination, filtering, and versioning in backend API development?▼

Implementing pagination, filtering, and versioning in API development requires applying specific architectural patterns. These practices prevent payload bloat and maintain backward compatibility as your interface scales.

What security principles should I follow when designing scalable APIs?▼

Security principles for scalable API design involve implementing standardized access controls and safe data exposure. Applying these best practices protects backend resources from unauthorized queries and mutations.

Related Skills

Explore More Software Engineering Skills→
mnthemnthe
4

backend-patterns

Provide backend design patterns for TypeScript/Node.js APIs, data models, and error handling.

Community
Basic
vuralserhat86vuralserhat86
43

api_design

Design RESTful and GraphQL APIs with OpenAPI and GraphQL schemas.

Community
Intermediate
cenjiecenjie

api-security-hardening

Secure REST APIs with authentication, rate limiting, CORS, and input validation.

Community
Advanced
gajjalaashok75-UIgajjalaashok75-UI
2

backend-architect

Design scalable backend architecture, APIs, and distributed service boundaries.

Community
Advanced