api-design
Design Consistent REST APIs
Inconsistent endpoints make APIs difficult to learn and maintain. This skill provides practical conventions for routes, methods, responses, errors, pagination, and documentation.
Install with my Agent
Copy this request to your Agent. It includes the canonical Skill page and manifest.
Review the Skillstore skill "api-design" from https://skillstore.io/skills/benny9193-api-design.md and its manifest at https://skillstore.io/api/skills/benny9193-api-design/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.Your Agent should still show its plan and request any confirmation required by the security policy.
Agent-readable resources
Use these links when an AI agent, crawler, or script needs clean context instead of reading the full page.
Test it
Using "api-design". Design endpoints for projects and project tasks.
Expected outcome:
- Use plural resources for projects and tasks.
- Keep task nesting limited to the project relationship.
- Use standard methods for creation, retrieval, updates, and deletion.
- Return created resources with status 201 and a Location header.
Using "api-design". Review an API that returns status 200 for every result.
Expected outcome:
Use specific success and error status codes so clients can distinguish outcomes without parsing response messages.
Using "api-design". Choose pagination for a large activity stream.
Expected outcome:
Prefer cursor pagination because records can change between requests. Return a continuation cursor and a clear indicator when more results exist.
Security Audit
SafeAll 48 static findings are false positives caused by Markdown fences, API examples, and ordinary terminology. The skill contains no executable commands, environment access, prompt injection, or malicious intent.
Risk Factors
⚙️ External commands (41)
🔑 Env variables (1)
Share & cite this report
Share the versioned assessment report, neutral badge, embed card, and citations. Skillstore reports evidence without deciding whether this Skill is safe.
Copy report link
https://skillstore.io/skills/benny9193-api-design/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown badge
[](https://skillstore.io/skills/benny9193-api-design?utm_source=security_passport_badge)HTML badge
<a href="https://skillstore.io/skills/benny9193-api-design?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/benny9193-api-design/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Embed card
<iframe src="https://skillstore.io/embed/skills/benny9193-api-design.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>Academic citations (APA · BibTeX · CFF)
APA citation
Benny9193. (2026). api-design security audit report (audit version 9) [Author version unspecified]. Skillstore. https://skillstore.io/skills/benny9193-api-design/audits/9BibTeX citation
@techreport{benny9193-benny9193-api-design-2026,
author = {Benny9193},
title = {api-design security audit report (audit version 9)},
institution = {Skillstore},
year = {2026},
number = {9},
url = {https://skillstore.io/skills/benny9193-api-design/audits/9},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "api-design security audit report (audit version 9)"
version: "unspecified"
type: report
authors:
- name: "Benny9193"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/benny9193-api-design/audits/9"
identifiers:
- type: other
value: "skillstore:benny9193-api-design:audit:9"
description: "Skillstore immutable audit report identifier"
Compare variants
2 installable variantsEach author remains a separate installable skill. The recommended variant is ranked by Skillstore evidence.
Why this variant is first
supercent-io-api-design
2026-08-21
benny9193-api-design
2026-08-21
Skillstore Score
Why this score Evidence Confidence: HighWhat You Can Build
Plan a new service API
Create a consistent endpoint plan before backend implementation begins.
Review an existing API
Identify inconsistent routes, methods, status codes, pagination, and response formats.
Define a shared API standard
Turn practical REST conventions into team documentation and review criteria.
Try These Prompts
Design REST endpoints for [resource]. Include list, create, retrieve, update, and delete operations with suitable status codes.
Propose consistent success, collection, validation, and error responses for [service]. Explain each field in plain language.
Review this API specification for route naming, HTTP methods, status codes, pagination, filtering, versioning, authentication, and errors: [specification].
Design a versioned REST contract for [domain]. Include relationships, cursor pagination, filtering, rate limits, authentication, error conventions, and OpenAPI documentation requirements.
Best Practices
- Define shared naming, response, and error conventions before adding endpoints.
- Document every request, response, status code, and failure case.
- Review security, authorization, and data exposure separately from interface consistency.
Avoid
- Do not place action verbs in resource URLs when HTTP methods already express the action.
- Do not return one status code for every success and failure.
- Do not expose unbounded collections without pagination and rate limits.