skills.rest
nikolanovoselec
nikolanovoselecCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Define REST API URL structures, HTTP methods, status codes, and response formats.

25|5|Updated Feb 22, 2026
Search Tags:#design#versioning#documentation#api#rest#pagination
One-click install
npx skills add https://github.com/nikolanovoselec/codeflare --skill api-design-nikolanovoselec
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/nikolanovoselec/codeflare/tree/main/preseed/agents/claude/skills/api-design
Command: npx skills add https://github.com/nikolanovoselec/codeflare --skill api-design-nikolanovoselec

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides comprehensive best practices for designing, documenting, and implementing REST APIs that are scalable, maintainable, and developer-friendly.

Core Features & Use Cases

  • Designing API resource structures: Establishes naming conventions and URL patterns for resources and sub-resources.
  • Defining HTTP methods and status codes: Ensures clear semantics and correct use of HTTP responses.
  • Standardizing response formats and pagination: Promotes uniform API responses and effective data navigation strategies.
  • Use Case: Developers designing a new web service can follow this guide to create REST endpoints that are predictable, versioned, and easy to consume by clients.

Quick Start

Follow the provided patterns to structure your API endpoints, choose appropriate HTTP methods, and implement consistent response formats to build scalable APIs.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I structure REST API URLs for resources and sub-resources?▼

REST API URL structures should use clear naming conventions and consistent patterns for resources and sub-resources to ensure endpoints are predictable, maintainable, and easy for clients to consume. This guide provides detailed conventions for establishing these resource hierarchies.

What HTTP methods and status codes should I use for REST API responses?▼

REST API design requires clear semantics and correct use of HTTP methods and status codes to ensure proper communication. This Skill defines appropriate HTTP responses and method mappings to standardize your web service endpoints effectively.

What is the best way to implement pagination in a REST API?▼

Pagination in a REST API promotes uniform responses and effective data navigation strategies for large datasets. This guide outlines best practices for standardizing response formats and implementing pagination to build scalable APIs.

How do I handle API versioning for maintainable REST endpoints?▼

API versioning is a core best practice for building maintainable REST endpoints that evolve safely without breaking existing clients. This Skill provides specific conventions for implementing versioning alongside consistent URL structures and response formats.

Does this REST API design guide work for building scalable web services from scratch?▼

Yes, this REST API design guide is built for developers designing a new web service who need to create scalable, developer-friendly endpoints. It provides the necessary patterns to build predictable, versioned APIs ready for client consumption.

Related Skills

Explore More Software Engineering Skills→
takemo101takemo101

basic-design-writer

Generate foundational system design documents in Japanese with Mermaid diagrams.

Community
Intermediate
hffmnnjhffmnnj
39

api-docs

Generate API reference documentation from OpenAPI specs and GraphQL schemas.

Community
Advanced
cenjiecenjie

api-security-hardening

Secure REST APIs with authentication, rate limiting, CORS, and input validation.

Community
Advanced
iludeilude
8

api-design-patterns

Design REST and GraphQL APIs with language-agnostic patterns for routes, schemas, and specs.

Community
Advanced