← Back to Skills Marketplace
Npjames Api Design
by
npjameszheng1125-netizen
· GitHub ↗
· v1.0.0
· MIT-0
224
Downloads
0
Stars
1
Active Installs
1
Versions
Install in OpenClaw
/install npjames-api-design
Description
REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting for production APIs.
Usage Guidance
This skill is an instruction-only documentation for REST API design and appears coherent and proportionate. Before installing, confirm you trust the publisher (source/homepage are missing) because provenance is unknown; review the full SKILL.md (including the truncated portion) to ensure no unexpected directives were omitted. Note the skill is allowed to be invoked implicitly by agents (allow_implicit_invocation), which can make it show up automatically in suggestions — this is normal but be aware of what capabilities you grant to autonomous agents in your environment.
Capability Analysis
Type: OpenClaw Skill
Name: npjames-api-design
Version: 1.0.0
The skill bundle is a comprehensive reference guide for REST API design patterns, covering resource naming, status codes, pagination, and authentication. All files, including SKILL.md and agents/openai.yaml, contain standard documentation and configuration consistent with the stated purpose of assisting in API design, with no evidence of malicious instructions, data exfiltration, or unauthorized execution.
Capability Assessment
Purpose & Capability
Name and description match the SKILL.md content: REST API design patterns (resource naming, status codes, pagination, filtering, error responses, versioning, rate limiting). The skill requests no binaries, env vars, or config paths that would be unnecessary for this purpose.
Instruction Scope
SKILL.md contains guidelines and examples for API design only. It does not direct the agent to read local files, access environment variables, call external endpoints, or collect/transmit user data beyond example request/response snippets.
Install Mechanism
No install spec and no code files beyond static documentation; nothing is written to disk or downloaded during install.
Credentials
The skill declares no required environment variables, credentials, or config paths. There is no disproportionate credential request relative to its design-guidance purpose.
Persistence & Privilege
agents/openai.yaml sets allow_implicit_invocation: true, permitting the skill to be invoked implicitly by the agent. This is not the same as always: true and is common for user-invocable helper skills; it increases how often the skill may be suggested but is not inherently problematic here.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install npjames-api-design - After installation, invoke the skill by name or use
/npjames-api-design - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release—comprehensive REST API design patterns and best practices:
- Covers resource naming, URL structure, HTTP methods, and status codes.
- Guides on pagination (offset and cursor), filtering, sorting, and search conventions.
- Details error handling formats and response envelope patterns.
- Includes examples for authentication, authorization, and rate limiting headers.
- Provides ready-to-use code and query samples for production-grade API contracts.
Metadata
Frequently Asked Questions
What is Npjames Api Design?
REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting for production APIs. It is an AI Agent Skill for Claude Code / OpenClaw, with 224 downloads so far.
How do I install Npjames Api Design?
Run "/install npjames-api-design" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Npjames Api Design free?
Yes, Npjames Api Design is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Npjames Api Design support?
Npjames Api Design is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Npjames Api Design?
It is built and maintained by npjameszheng1125-netizen (@npjameszheng1125-netizen); the current version is v1.0.0.
More Skills