skills.rest
TymorIbrahim
TymorIbrahimCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Design RESTful API patterns with resource naming, HTTP methods, and status codes.

Updated Jun 22, 2026
Search Tags:#versioning#authorization#authentication#api design#rate limiting#rest api#pagination#status codes#http methods
One-click install
npx skills add https://github.com/TymorIbrahim/UniPilot --skill api-design-tymoribrahim
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/TymorIbrahim/UniPilot/tree/main/.cursor/.agents/skills/api-design
Command: npx skills add https://github.com/TymorIbrahim/UniPilot --skill api-design-tymoribrahim

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill provides comprehensive guidance on designing and implementing REST APIs, addressing common challenges in production-grade API development.

Core Features & Use Cases

  • Resource Naming: Best practices for naming resources and URLs.
  • HTTP Methods and Status Codes: Understanding and implementing proper HTTP semantics.
  • Pagination: Strategies for efficient data retrieval with cursor-based and offset-based pagination.
  • Filtering, Sorting, and Search: Techniques for enhancing API usability.
  • Authentication and Authorization: Implementing secure access control.
  • Rate Limiting: Protecting APIs from abuse and ensuring fair usage.
  • Versioning: Strategies for managing API evolution.
  • Implementation Patterns: Examples in TypeScript, Python, and Go.
  • API Design Checklist: Ensuring best practices are followed.
  • Use Case: A developer can use this Skill to design a new API endpoint, review an existing API, or implement a specific API design pattern.

Quick Start

Use the api-design skill to create a new API endpoint for user management with proper resource naming, HTTP methods, and status codes.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design a REST API with proper resource naming and HTTP methods?▼

REST API design requires structuring resource URLs logically and mapping operations to correct HTTP methods like GET, POST, PUT, and DELETE. ThisSkill provides production-grade patterns for resource naming and HTTP semantics to ensure standard API behavior.

What are the best practices for implementing pagination and filtering in a REST API?▼

Pagination and filtering in a REST API are best handled using cursor-based or offset-based strategies for data retrieval. This Skill outlines techniques for efficient pagination, sorting, and search to enhance API usability and manage large datasets.

How does rate limiting and authentication work in production REST APIs?▼

Rate limiting and authentication protect REST APIs from abuse and secure access control. This Skill details implementing secure authorization, authentication protocols, and rate limiting strategies to ensure fair API usage and resource protection.

Can I use this API design guidance for TypeScript, Python, and Go implementations?▼

Yes, this API design guidance supports implementation patterns in TypeScript, Python, and Go. It provides concrete examples for developers and architects to apply REST API patterns directly in these programming languages.

What is the best way to handle API versioning and status codes?▼

API versioning manages API evolution, while proper HTTP status codes communicate response success or errors clearly. This Skill offers strategies for versioning APIs and implementing correct status codes to maintain backward compatibility.

Related Skills

Explore More Software Engineering Skills→
tinkermonkeytinkermonkey

LAYER_07_DATA_MODEL

Define and validate object data structures using JSON Schema Draft 7.

Community
Advanced
HouseGarofaloHouseGarofalo
3

openapi-swagger

Design, document, and generate APIs from OpenAPI and Swagger specifications.

Official
Advanced
JaimeJunrJaimeJunr
2

api-design

Standardize REST API patterns for pagination, filtering, error handling, and versioning.

Community
Advanced
iludeilude
8

api-design-patterns

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

Community
Advanced