hello-api

Enforces REST API design standards for endpoints, validation, responses, and rate limiting.

702|99|Updated Sep 26, 2025
One-click install
npx skills add https://github.com/hellowind777/helloagents --skill hello-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: hello-api
Source: https://github.com/hellowind777/helloagents/tree/main/skills/hello-api
Command: npx skills add https://github.com/hellowind777/helloagents --skill hello-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

API code often ships with inconsistent status codes, missing input validation, unpaginated list endpoints, and no rate limiting, leading to fragile integrations and security gaps. This Skill provides a concrete checklist of API design rules so every endpoint follows the same contract.

Core Features & Use Cases

  • RESTful Design Rules: Enforces plural resource naming, correct HTTP method semantics, and accurate status codes (200, 201, 400, 401, 403, 404, 409, 422, 500).
  • Request Validation & Response Format: Requires schema validation with zod, joi, or ajv at the controller layer, plus unified success ({ data, meta? }) and error ({ error: { code, message, details? } }) response shapes.
  • Versioning & Protection: Covers URL-based API versioning, rate limiting by IP/user/API key, timeouts on external calls, and explicit CORS origins.
  • Use Case: When building a new /users endpoint, the Skill ensures you add pagination, sorting, filter whitelists, and a delivery checklist before marking the work complete.

Quick Start

Ask the AI to build or review a REST API endpoint following the hello-api standards, for example: create a paginated GET /v1/users endpoint with validated query parameters.

Frequently Asked Questions about hello-api

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

FAQPage Schema
How do I design a RESTful API endpoint correctly?

Use plural nouns for resources like /users, nest related resources like /users/:id/posts, and map HTTP methods to semantics: GET reads, POST creates, PUT fully updates, PATCH partially updates, DELETE removes. Return accurate status codes such as 201 for creation and 422 for validation failures.

What is the best way to validate API request bodies?

Validate inputs at the controller layer using a schema validation library such as zod, joi, or ajv. Check types, ranges, formats, and required fields, and also limit file upload sizes and overall request body size.

How should API list endpoints handle pagination?

Every list endpoint must support pagination, either page-based with ?page=1&limit=20 or cursor-based. Also support sorting via ?sort=created_at&order=desc and restrict filter parameters to a whitelist.

What HTTP status codes should a REST API return?

Return 200 for success, 201 for creation, 204 for no content, 400 for bad parameters, 401 for unauthenticated, 403 for forbidden, 404 for missing resources, 409 for conflicts, 422 for validation failures, and 500 for server errors.

How do I protect an API with rate limiting and CORS?

Apply rate limiting per IP, user, or API key, set timeouts on all external calls, and configure CORS with explicitly allowed origins instead of using a wildcard. Version the API via a URL prefix like /v1/ or a header.