hummbl-io/agent-skills/api-design

Claude Code and agent skill by hummbl-io/agent-skills

Trust tier 3
  • community
Source check pending

Checking that the SKILL.md file is still in the repository.

Design REST/HTTP APIs with consistent patterns -- endpoints, errors, pagination, auth.

Install

npx vskill@latest install hummbl-io/agent-skills/api-design

SKILL.md

The same SKILL.md was published earlier as hummbl-io/agent-skills/api-design.

API Design

Design consistent HTTP APIs following REST conventions and our project patterns.

Execution

1. Define resources

What are the nouns? Map them to endpoints:

/api/v1/agents GET (list), POST (create)
/api/v1/agents/:id GET (detail), PATCH (update), DELETE
/api/v1/agents/:id/bus GET (agent's bus messages)
2. Apply conventions
ConventionPattern
Versioning/api/v1/ prefix
NamingPlural nouns, kebab-case ([bus-messages], not [busMessages])
FilteringQuery params: ?type=STATUS&since=2026-03-16
Pagination?limit=20&offset=0, return total in response
Sorting?sort=-created_at (prefix - for descending)
Errors{"error": {"code": "NOT_FOUND", "message": "Agent not found"}}
AuthBearer token in Authorization header
Content-Typeapplication/json always
3. Define error codes
HTTP StatusWhenError Code
400Bad request body/paramsVALIDATION_ERROR
401Missing/invalid authUNAUTHORIZED
403Authenticated but not allowedFORBIDDEN
404Resource not foundNOT_FOUND
409Conflict (e.g., duplicate)CONFLICT
422Valid JSON but invalid semanticsUNPROCESSABLE
429Rate limitedRATE_LIMITED
500Internal errorINTERNAL_ERROR
4. Design for our stack
  • Stdlib only: use http.server or document as FastAPI (dashboard only)
  • JSON schemas from contracts/ are the source of truth
  • IDP delegation tokens for auth where applicable
  • Circuit breaker wrapping for external calls
5. Write OpenAPI stub (optional)
yaml
openapi: 3.0.0
info:
title: <API Name>
version: 0.1.0
paths:
/api/v1/<resource>:
get:
summary: List <resources>
parameters:
- name: limit
in: query
schema: { type: integer, default: 20 }

Output Format

API Design | <name>
══════════════════════
## Resources
<endpoint table>
## Authentication
<auth mechanism>
## Example Requests
<curl examples for key operations>
## Error Handling
<error code table>
## Schema References
<which contracts/ schemas apply>

Base120 Context

  • Primary: CO9 (Interface Contracts)
  • Related: SY12 (Protocol Standards), CO8 (Layered Abstraction)

Security

  • Security scanPassed, 90 of 100Pattern checks on the skill's files.
  • Model reviewPassed

Quality evaluation

  • Task evaluationNot runNo evaluation yet. Run one in Skill Studio.

Source

Popularity

7-day trend score
5

Not refreshed yet.

Works with

Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.

  • Claude Code
  • Cursor
  • GitHub Copilot
  • Windsurf
  • Codex
  • Gemini CLI
  • Cline
  • Amp
  • Roo Code
  • Goose
  • Continue
  • Kilo Code
  • Junie
  • Trae
  • OpenHands
  • Qwen Code
  • AI Agent
  • Tabnine Chat
  • Sourcegraph Cody
  • Amazon Q
  • Firebase Genkit
  • Sweep
  • Devin
  • Phind
  • Mentat
  • Claude Desktop
  • Aider
  • GPT Pilot
  • Plandex
  • bolt.new
  • v0
  • Replit Agent
  • Anse
  • TypingMind
  • BetterChatGPT
  • LibreChat
  • Warp AI
  • Pieces
  • Fig AI
Embed badge
vskill VERIFIED badge
[![vskill VERIFIED](https://verified-skill.com/api/v1/skills/hummbl-io/agent-skills/api-design/badge)](https://verified-skill.com/skills/hummbl-io/agent-skills/api-design)

Something wrong with this skill or its page? Tell us.