skills.rest
trudyan141
trudyan141COMMUNITY
Explore all skills by this author →
GitHub

rest-api-expert

Designs and reviews REST APIs covering endpoints, HTTP semantics, errors, pagination, and versioning.

3|Updated Jan 15, 2026
Search Tags:#error handling#api design#openapi#rest api#pagination#api versioning#http status codes
One-click install
npx skills add https://github.com/trudyan141/my-antigravity-agents-kit --skill rest-api-expert-trudyan141
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: rest-api-expert
Source: https://github.com/trudyan141/my-antigravity-agents-kit/tree/main/templates/.agent/skills/rest-api-expert
Command: npx skills add https://github.com/trudyan141/my-antigravity-agents-kit --skill rest-api-expert-trudyan141

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? It helps developers design consistent, well-structured REST APIs and fix common issues like non-RESTful URLs, wrong HTTP status codes, inconsistent error formats, and missing pagination or versioning strategies. ## Core Features & Use Cases - Endpoint & Resource Design: Converts verb-based URLs into noun-based resource hierarchies with proper filtering, sorting, and nested resources. - HTTP Semantics & Error Handling: Provides correct method/status code selection and a standardized error response format with field-level validation details. - Pagination, Versioning & Documentation: Implements offset and cursor-based pagination, URL path versioning with deprecation headers, and OpenAPI-aligned review checklists. - Use Case: When building an Express API, use it to restructure routes like /getUsers into /users, add Zod request validation, and return consistent 400/404/500 error payloads. ## Quick Start Review my Express API routes and redesign them following RESTful best practices with proper status codes and error handling.

Frequently Asked Questions about rest-api-expert

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

FAQPage Schema
How do I design RESTful API endpoints correctly?▼

Use nouns instead of verbs in URLs, such as GET /users and POST /users instead of /getUsers or /createUser. Model relationships as nested resources like /users/123/orders, and keep nesting to a maximum of two levels.

Which HTTP status code should I use for API responses?▼

Use 200 for successful reads, 201 with a Location header for creations, 204 for successful deletes, 400 for validation failures, 404 for missing resources, 409 for conflicts, and 500 for unexpected server errors.

What is the difference between offset and cursor pagination?▼

Offset pagination uses page and limit parameters and is simple but slow on large datasets. Cursor pagination encodes the last item's ID in an opaque cursor, giving consistent performance regardless of dataset size.

How do I version a REST API without breaking clients?▼

Use URL path versioning like /api/v1/users and /api/v2/users, mounting separate routers per version. Communicate deprecation with Deprecation, Sunset, and Link headers pointing to the successor version.

When should I not use REST for an API?▼

REST is a poor fit for strongly typed service-to-service calls where gRPC with Protocol Buffers is better, or for flexible client-driven queries where GraphQL excels. This skill defers those cases to the appropriate specialist.

Related Skills

Explore More Software Engineering Skills→
armanzeroeightarmanzeroeight
29

rest-api-designer

Design RESTful API endpoints with resource models, HTTP methods, and URL structures.

Community
Intermediate
RaheesAhmedRaheesAhmed
66

api-architect

Design REST and GraphQL APIs with authentication, versioning, and OpenAPI documentation.

Community
Advanced
cwinvestmentscwinvestments
412

memstack-security-api-audit

Audit Next.js API routes for authentication, authorization, and input validation vulnerabilities.

Community
Advanced
nekorush14nekorush14
4

rails-grpc-implementation

Implement gRPC services and clients in Rails with Protocol Buffers.

Community
Advanced