skills.rest
JosephRobles23
JosephRobles23COMMUNITY
Explore all skills by this author →
GitHub

api-design-principles

Guide RESTful and GraphQL API design with schema, versioning, and error handling principles.

Updated Aug 23, 2026
Search Tags:#api design#rest#developer experience#graphql#api patterns#api best practices
One-click install
npx skills add https://github.com/JosephRobles23/Vora.IA --skill api-design-principles-josephrobles23
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/JosephRobles23/Vora.IA/tree/main/.agents/skills/api-design-principles
Command: npx skills add https://github.com/JosephRobles23/Vora.IA --skill api-design-principles-josephrobles23

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps developers design, review, and standardize intuitive, scalable, and maintainable REST and GraphQL APIs, ensuring a better developer experience.

Core Features & Use Cases

  • API Design Guidance: Provides principles and patterns for both RESTful and GraphQL API design.
  • Best Practices: Covers resource naming, HTTP methods, status codes, versioning, error handling, and more.
  • Use Case: A team is starting a new microservice and needs to define its API contract. They can use this Skill to ensure they follow established best practices for RESTful design, including proper resource representation, HTTP method usage, and error handling.

Quick Start

Review the RESTful design principles for resource collection design.

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

RESTful API design best practices include resource-oriented architecture, proper HTTP method usage, correct status codes, and structured error handling. This Skill provides comprehensive guidance on resource naming and representation to ensure your API is intuitive and maintainable.

How do I design a scalable GraphQL schema for a new microservice?▼

To design a scalable GraphQL schema, you need principles for schema design, versioning, and error handling. This Skill offers structured advice and code examples for both REST and GraphQL paradigms to facilitate creating maintainable API contracts.

REST vs GraphQL: which API design pattern should I choose for my application?▼

Choosing between REST and GraphQL depends on your architectural needs. This Skill compares both API paradigms, covering principles and patterns for resource-oriented architecture versus schema design to help you select the best approach.

How do I handle API versioning and error handling in a RESTful API?▼

API versioning and error handling are core features of this Skill's guidance. It provides structured advice on standard HTTP status codes and error representation patterns to ensure a better developer experience for RESTful APIs.

Related Skills

Explore More Software Engineering Skills→
VeradelaCruzVeradelaCruz

api-design

Define API requirements and generate OpenAPI or GraphQL schemas.

Community
Intermediate
labluplablup
662

api-guide

Implement REST and GraphQL APIs with scope-based routing and admin prefixes.

Official
Advanced
jeremylongshorejeremylongshore
2.6k

generating-orm-code

Generate ORM models and database schemas across multiple frameworks.

Community
Intermediate
andy4917andy4917

ts-structure-code-review

Analyze TypeScript code for architectural weaknesses, type inconsistencies, and error handling gaps.

Community
Advanced