skills.rest
mozilor-technologies
mozilor-technologiesOFFICIAL
Explore all skills by this author →
GitHub

api-design-principles

Define best practices for designing, documenting, and maintaining REST and GraphQL APIs.

Updated Apr 16, 2026
Search Tags:#design#best practices#api#rest#graphql
One-click install
npx skills add https://github.com/mozilor-technologies/mozilor-skills --skill api-design-principles-mozilor-technologies
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/mozilor-technologies/mozilor-skills/tree/main/skills/backend/language-specific/api-design
Command: npx skills add https://github.com/mozilor-technologies/mozilor-skills --skill api-design-principles-mozilor-technologies

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Designing effective REST and GraphQL APIs can be complex and error-prone, leading to poor developer experience and maintenance challenges.

Core Features & Use Cases

  • API Standardization: Provides guidelines for consistent resource naming, status codes, and versioning.
  • Design Patterns: Covers resource-oriented architecture, pagination, filtering, and error handling strategies.
  • Use Case: Use this skill when creating or reviewing APIs for web services, ensuring they are intuitive, reliable, and maintainable.

Quick Start

Use the API design principles guide to structure your new RESTful or GraphQL API for clarity and robustness.

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 versioning and resource naming?▼

REST API design best practices involve standardizing resource naming, applying correct HTTP status codes, and implementing versioning strategies to ensure your web service endpoints remain intuitive, reliable, and maintainable.

How do I design pagination and filtering for scalable GraphQL and REST APIs?▼

To design scalable APIs, apply resource-oriented architecture patterns for pagination and filtering, ensuring efficient data retrieval and consistent developer experience for both REST and GraphQL implementations.

Does this API design guide require familiarity with HTTP standards?▼

Yes, designing enterprise APIs with this guide requires familiarity with HTTP standards, API versioning, and schema design to effectively implement consistent and developer-friendly REST and GraphQL architectures.

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

The best way to handle API errors involves structured error handling strategies and thorough documentation practices, ensuring API consistency and a better developer experience for enterprise software engineering workflows.

REST vs GraphQL: how do I maintain consistency across enterprise APIs?▼

Maintaining consistency across REST and GraphQL APIs requires standardized guidelines for resource naming, error handling, and schema design, ensuring both architectural approaches remain scalable and user-friendly within enterprise systems.

Related Skills

Explore More Software Engineering Skills→
vinaykumarvkvinaykumarvk
1

quality-review

Analyzes codebase quality, security, testing, and maintainability metrics across software projects.

Community
Advanced
icartshicartsh
4

api-designer

Design RESTful and GraphQL APIs with OpenAPI 3.0 specifications.

Community
Advanced
FutureAtomsFutureAtoms
1

playwright-api-testing

Automate REST and GraphQL API tests with Playwright's APIRequestContext.

Community
Advanced
tomasbassotomasbasso

principios-diseno-apis

Enforce REST API standards for naming, HTTP methods, status codes, and versioning.

Community
Intermediate