api-design-principles

Automates REST and GraphQL API design guidance for standardization.

Updated Mar 29, 2026
One-click install
npx skills add https://github.com/sigitpoerwo/repoworkspace_zahra --skill api-design-principles-sigitpoerwo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/sigitpoerwo/repoworkspace_zahra/tree/main/skills/02-PERLU-SETUP/butuh-belajar/api-design-principles
Command: npx skills add https://github.com/sigitpoerwo/repoworkspace_zahra --skill api-design-principles-sigitpoerwo

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Define and standardize API design across REST and GraphQL to reduce friction and improve developer experience.

Core Features & Use Cases

  • Define consumers, use cases, and constraints for API designs.
  • Choose API styles, model resources, and establish versioning, pagination, and auth strategies.
  • Create developer-friendly documentation and validation checklists to ensure consistency across teams.

Quick Start

Ask AI to outline a complete API design contract for a REST/GraphQL service using standard patterns.

Frequently Asked Questions about api-design-principles

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I standardize REST and GraphQL API design across my team?

Standardize REST and GraphQL API design by defining consumers, modeling resources, and establishing versioning, pagination, and authentication strategies. This ensures consistency across web services and improves the overall developer experience through validation checklists.

What is the best way to model resources and handle errors for a new API?

Model resources and handle errors by applying standard API design patterns for your architecture. This involves choosing an API style, structuring resource models, and implementing consistent error handling strategies to create a robust and scalable web service contract.

Can I generate a complete API design contract for both REST and GraphQL services?

Yes, you can generate a complete API design contract for REST and GraphQL services. The process automates guidance for resource modeling, error handling, versioning, and documentation references to satisfy standard web service requirements.

How do I establish authentication and pagination strategies for scalable APIs?

Establish authentication and pagination strategies by defining constraints and use cases during the API design phase. Applying standard pagination and auth patterns ensures your REST or GraphQL architecture remains robust and scalable as consumer demand grows.

Does this API design guidance include developer documentation references?

Yes, API design guidance includes creating developer-friendly documentation and validation checklists. This ensures consistency across team practices and standardizes developer docs for your REST and GraphQL web services.