Skip to content
cccskills
FreePublished on GitHub

api-design-principles

Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers. Use when designing new APIs, reviewing API specifications, or establishing...

The English summary is being prepared. Showing the original description.

netbarros/psique
See how to install

Files included (6)

  • SKILL.md1.5 KB
  • assets/api-design-checklist.md3.8 KB
  • assets/rest-api-template.py5.2 KB
  • references/graphql-schema-design.md8.8 KB
  • references/rest-best-practices.md7.4 KB
  • resources/implementation-playbook.md12.7 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

API Design Principles

Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.

Use this skill when

  • Designing new REST or GraphQL APIs
  • Refactoring existing APIs for better usability
  • Establishing API design standards for your team
  • Reviewing API specifications before implementation
  • Migrating between API paradigms (REST to GraphQL, etc.)
  • Creating developer-friendly API documentation
  • Optimizing APIs for specific use cases (mobile, third-party integrations)

Do not use this skill when

  • You only need implementation guidance for a specific framework
  • You are doing infrastructure-only work without API contracts
  • You cannot change or version public interfaces

Instructions

  1. Define consumers, use cases, and constraints.
  2. Choose API style and model resources or types.
  3. Specify errors, versioning, pagination, and auth strategy.
  4. Validate with examples and review for consistency.

Refer to resources/implementation-playbook.md for detailed patterns, checklists, and templates.

Resources

  • resources/implementation-playbook.md for detailed patterns, checklists, and templates.

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

00-andruia-consultant

Free

Arquitecto de Soluciones Principal y Consultor Tecnológico de Andru.ia. Diagnostica y traza la hoja de ruta óptima para proyectos de IA en español.

The English summary is being prepared. Showing the original description.

netbarros/psique6Updated Apr 22, 2026

10-andruia-skill-smith

Free

Ingeniero de Sistemas de Andru.ia. Diseña, redacta y despliega nuevas habilidades (skills) dentro del repositorio siguiendo el Estándar de Diamante.

The English summary is being prepared. Showing the original description.

netbarros/psique6Updated Apr 22, 2026

20-andruia-niche-intelligence

Free

Estratega de Inteligencia de Dominio de Andru.ia. Analiza el nicho específico de un proyecto para inyectar conocimientos, regulaciones y estándares únicos del sector. Actívalo tras definir el nicho.

The English summary is being prepared. Showing the original description.

netbarros/psique6Updated Apr 22, 2026

3d-web-experience

Free

Expert in building 3D experiences for the web - Three.js, React Three Fiber, Spline, WebGL, and interactive 3D scenes. Covers product configurators, 3D portfolios, immersive websites, and bringing ...

The English summary is being prepared. Showing the original description.

netbarros/psique6Updated Apr 22, 2026

ab-test-setup

Free

Structured guide for setting up A/B tests with mandatory gates for hypothesis, metrics, and execution readiness.

The English summary is being prepared. Showing the original description.

netbarros/psique6Updated Apr 22, 2026

accessibility-compliance-accessibility-audit

Free

You are an accessibility expert specializing in WCAG compliance, inclusive design, and assistive technology compatibility. Conduct audits, identify barriers, and provide remediation guidance.

The English summary is being prepared. Showing the original description.

netbarros/psique6Updated Apr 22, 2026

See all skills by netbarros

Report a problem with this skill