skills.rest
bereniketech
bereniketechCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Enforces REST API design conventions including URLs, HTTP statuses, errors, pagination, versioning, authentication, and OpenAPI documentation.

Updated Aug 23, 2026
Search Tags:#versioning#openapi#pagination#api-design#rest-api#http-status-codes
One-click install
npx skills add https://github.com/bereniketech/claude_kit --skill api-design-bereniketech
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/bereniketech/claude_kit/tree/main/skills/development/api-design
Command: npx skills add https://github.com/bereniketech/claude_kit --skill api-design-bereniketech

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Design conventions that make REST APIs predictable, easy to consume, and safe to evolve, reducing onboarding time and integration errors.

Core Features & Use Cases

  • URL conventions with plural, lowercase nouns and no embedded verbs.
  • Standardized HTTP methods, status codes, error envelopes, and rate limiting.
  • Pagination, filtering, versioning, authentication, and OpenAPI documentation to support public and internal APIs.

Quick Start

Apply these REST API design conventions to your new services to ensure consistency and safety.

Frequently Asked Questions about api-design

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

FAQPage Schema
What are the best REST API conventions for URL naming and HTTP methods?▼

REST API design standardizes HTTP status codes and error envelopes to provide consistent, predictable responses. This approach reduces onboarding time and integration errors by giving consumers clear, actionable feedback for every request state.

How do I handle REST API pagination and filtering?▼

REST API design handles pagination and filtering through standardized conventions applied to URL parameters. This ensures efficient data retrieval and consistent query behavior across large datasets in both public and internal services.

What's the best way to version a REST API?▼

Versioning a REST API requires standardized conventions to ensure safe evolution over time. Implementing consistent versioning strategies prevents breaking changes for existing consumers while allowing new features to be introduced safely.

Does REST API design include OpenAPI documentation?▼

REST API design includes OpenAPI documentation to support both public and internal APIs. Generating OpenAPI specifications provides standardized, machine-readable documentation that accelerates client integration and enforces contract compliance.

How do I standardize authentication and rate limiting in a REST API?▼

Standardizing authentication and rate limiting in a REST API involves applying consistent design conventions across all endpoints. This approach secures public and internal services while maintaining predictable developer experiences.

Related Skills

Explore More Software Engineering Skills→
sehoon787sehoon787
16

springboot-patterns

Apply scalable Spring Boot architecture patterns to backend services.

Community
Advanced
fgarofalo56fgarofalo56
6

openapi-swagger

Design, document, generate, validate, and mock RESTful APIs with OpenAPI and Swagger.

Community
Advanced
altrupetsaltrupets

API Gateway & Rate Limiting

Implement API Gateway patterns and rate limiting with Kong or Nginx.

Official
Intermediate
iludeilude
8

api-design-patterns

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

Community
Advanced