← Back to Skills Marketplace
Http Api
by
codenova58
· GitHub ↗
· v1.0.0
· MIT-0
273
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install http-api
Description
Shape HTTP/JSON APIs—resources and verbs, error payloads, pagination, idempotency, and docs. Use when designing new endpoints, reviewing PRs, or aligning tea...
README (SKILL.md)
HTTP API
Design and review HTTP-facing APIs (usually JSON): predictable URLs, honest status codes, and errors clients can build on—without duplicating everything your api-compat skill covers for long-lived versioning policy.
Scope
- Modeling: nouns/resources, collections, actions when RPC-style is clearer than fake REST.
- HTTP semantics: which methods, idempotency, caching headers when relevant.
- Errors: stable machine-readable codes, correlation ids, avoid leaking internals.
- DX: examples, OpenAPI snippets, consistent pagination/filter patterns.
Out of scope (hand off)
- OAuth/OIDC protocol details → identity-focused skills.
- GraphQL-only schema design → graphql-schema skill.
- Multi-year deprecation policy and client migration programs → pair with api-compat.
Review order
- Read paths — Can a client navigate the domain without guessing?
- Write safety — Retries safe? Duplicate submits handled?
- Errors — One shape everywhere; 4xx vs 5xx honest.
- Evolution — Document what may change vs what is stable (compat details in api-compat).
Smells
- Status 200 with
{error: ...}; every POST returns 200; unbounded list endpoints; secrets in error bodies.
Done when
- A new engineer can call the API from docs alone; failure cases are testable and consistent.
Usage Guidance
This skill is an offline, text-only guide for designing and reviewing HTTP/JSON APIs and does not access credentials or your filesystem. It appears safe and coherent to install, but remember: it's advice—validate any suggested changes against your organization's security, compatibility, and operational policies before applying them. If you need machine-executable checks or integrations (tests, CI automation, versioning policies), look for or request a skill that explicitly declares those capabilities and the minimal required credentials or install steps.
Capability Analysis
Type: OpenClaw Skill
Name: http-api
Version: 1.0.0
The skill bundle contains only metadata and documentation (SKILL.md) focused on best practices for HTTP API design and review. It provides architectural guidance on RESTful conventions, error handling, and idempotency without any executable code, external dependencies, or suspicious instructions.
Capability Assessment
Purpose & Capability
The name/description (HTTP API design and reviews) matches the SKILL.md content. There are no environment variables, binaries, or config paths requested that would be unrelated to API design.
Instruction Scope
SKILL.md contains only prose-level guidance for API modeling, HTTP semantics, errors, DX, and review order. It does not instruct the agent to read files, access environment variables, call external endpoints, or collect user/system data.
Install Mechanism
No install specification and no code files are present (instruction-only). Nothing will be written to disk or downloaded as part of installation.
Credentials
The skill requests no environment variables, credentials, or configuration paths; nothing disproportionate is requested for the stated design/review purpose.
Persistence & Privilege
Skill flags show default behavior (not always: true) and model invocation is allowed (platform default). There is no indication the skill tries to persist or modify other skills or system-wide configuration.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install http-api - After installation, invoke the skill by name or use
/http-api - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release of the http-api skill.
- Guides on designing and reviewing RESTful HTTP/JSON APIs, focusing on clarity and consistency.
- Covers resource modeling, HTTP methods, status codes, error shape, idempotency, and common DX patterns.
- Outlines clear review steps and API "smells" to avoid.
- Specifies boundaries with related skills (api-compat, graphql-schema, authentication).
- Emphasizes self-serve documentation and robust error handling.
Metadata
Frequently Asked Questions
What is Http Api?
Shape HTTP/JSON APIs—resources and verbs, error payloads, pagination, idempotency, and docs. Use when designing new endpoints, reviewing PRs, or aligning tea... It is an AI Agent Skill for Claude Code / OpenClaw, with 273 downloads so far.
How do I install Http Api?
Run "/install http-api" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Http Api free?
Yes, Http Api is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Http Api support?
Http Api is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Http Api?
It is built and maintained by codenova58 (@codenova58); the current version is v1.0.0.
More Skills