skills.rest
tomasbasso
tomasbassoCOMMUNITY
Explore all skills by this author →
GitHub

principios-diseno-apis

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

Updated Apr 25, 2026
Search Tags:#design#versioning#api#rest#errors#pagination#naming
One-click install
npx skills add https://github.com/tomasbasso/SistemaStockV2 --skill principios-diseno-apis
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: principios-diseno-apis
Source: https://github.com/tomasbasso/SistemaStockV2/tree/main/.agents/skills/principios-diseno-apis
Command: npx skills add https://github.com/tomasbasso/SistemaStockV2 --skill principios-diseno-apis

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Inconsistent REST API designs lead to integration friction, onboarding delays, and security gaps. This guide provides a formalized set of rules to unify endpoints, responses, and access controls across services.

Core Features & Use Cases

  • Nouns over verbs in resource naming to promote intuitive endpoints (e.g., /products, not /getProducts).
  • Logical resource hierarchy and consistent CRUD mappings to HTTP methods.
  • Standardized status codes, error models, pagination, filtering, and versioning to enable predictable client interactions.
  • Authentication, authorization, and error handling guidance to improve security and debuggability.
  • Real-world use cases include designing public APIs for partners and internal microservices ecosystems.

Quick Start

Apply these REST API design standards to your project by updating endpoints to use nouns, aligning HTTP methods and status codes, and enabling pagination and versioning.

Frequently Asked Questions about principios-diseno-apis

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

FAQPage Schema
How do I design REST API endpoints for consistency and scalability?▼

To design REST API endpoints for consistency, use nouns instead of verbs for resource naming, map CRUD operations logically to HTTP methods, and standardize response formats. This prevents integration friction across microservices and public partner integrations.

What are the best practices for REST API versioning and pagination?▼

REST API versioning and pagination best practices involve standardizing these mechanisms to enable predictable client interactions. Applying formal rules for pagination and versioning ensures that your API can evolve safely without breaking existing integrations.

How should I handle HTTP status codes and error handling in a REST API?▼

HTTP status codes and error handling in a REST API should be standardized using a consistent error model. Aligning status codes with HTTP methods and applying formalized error handling guidance improves security and makes debugging integration issues significantly easier.

Can I apply these REST API design standards to small internal microservices?▼

Yes, these REST API design standards can be applied to API projects of any size. The formalized rules for resource naming, access control, and security are designed to unify endpoints across both small internal microservices and large public partner APIs.

Why use nouns instead of verbs for REST API resource naming?▼

Using nouns instead of verbs for REST API resource naming promotes intuitive endpoints, such as using /products rather than /getProducts. This approach establishes a logical resource hierarchy and aligns directly with consistent CRUD mappings to HTTP methods.

Related Skills

Explore More Software Engineering Skills→
VeradelaCruzVeradelaCruz

api-design

Define API requirements and generate OpenAPI or GraphQL schemas.

Community
Intermediate
gil00pitagil00pita

rest-api-design

Design REST APIs with consistent resource naming, HTTP methods, and status codes.

Community
Advanced
michaelsvanbeekmichaelsvanbeek
1

api-design

Define REST API design patterns and contract standards for endpoints and OpenAPI documentation.

Community
Advanced
majiayu000majiayu000
258

api-design

Design API contracts for REST, GraphQL, and gRPC contexts.

Community
Advanced