designing-apis
Design Clean REST and GraphQL APIs
Designing consistent APIs from scratch is slow and error-prone, and inconsistent endpoints confuse consumers. This skill gives Claude a structured workflow with proven patterns for endpoints, errors, versioning, authentication, and OpenAPI documentation.
Install with my Agent
Copy this request to your Agent. It includes the canonical Skill page and manifest.
Review the Skillstore skill "designing-apis" from https://skillstore.io/skills/cloudai-x-designing-apis.md and its manifest at https://skillstore.io/api/skills/cloudai-x-designing-apis/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 "designing-apis". Design REST endpoints for a users resource.
Expected outcome:
The skill returns a resource-based route set: GET /users to list users, GET /users/{id} to fetch one, POST /users to create, PUT and PATCH /users/{id} to replace or update, and DELETE /users/{id} to remove. Each route is paired with the recommended HTTP status code.
Using "designing-apis". What status codes should my error responses use?
Expected outcome:
The skill explains that 400 signals bad input, 401 signals missing or invalid authentication, 403 signals a permission problem, 404 signals a missing resource, 409 signals a conflict, 422 signals a validation failure, and 429 signals rate limiting.
Using "designing-apis". How should I version my public API?
Expected outcome:
The skill recommends URL versioning such as /api/v1/users as the primary approach and describes header versioning with an Accept header as an alternative for teams that prefer it.
Security Audit
SafeThis skill is a static Markdown reference guide for designing REST and GraphQL APIs. All 36 static findings are false positives: the flagged patterns are Markdown code fences misread as shell/Ruby backtick execution, an example placeholder URL, and REST/OpenAPI documentation snippets misread as system reconnaissance. There is no executable code, no network activity, no filesystem or environment access, and no prompt-injection content. The skill is safe.
Risk Factors
🌐 Network access (1)
⚙️ External commands (23)
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/cloudai-x-designing-apis/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown badge
[](https://skillstore.io/skills/cloudai-x-designing-apis?utm_source=security_passport_badge)HTML badge
<a href="https://skillstore.io/skills/cloudai-x-designing-apis?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/cloudai-x-designing-apis/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Embed card
<iframe src="https://skillstore.io/embed/skills/cloudai-x-designing-apis.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
CloudAI-X. (2026). designing-apis security audit report (audit version 9) [Author version unspecified]. Skillstore. https://skillstore.io/skills/cloudai-x-designing-apis/audits/9BibTeX citation
@techreport{cloudai-x-cloudai-x-designing-apis-2026,
author = {CloudAI-X},
title = {designing-apis security audit report (audit version 9)},
institution = {Skillstore},
year = {2026},
number = {9},
url = {https://skillstore.io/skills/cloudai-x-designing-apis/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: "designing-apis security audit report (audit version 9)"
version: "unspecified"
type: report
authors:
- name: "CloudAI-X"
date-released: "2026-07-18"
url: "https://skillstore.io/skills/cloudai-x-designing-apis/audits/9"
identifiers:
- type: other
value: "skillstore:cloudai-x-designing-apis:audit:9"
description: "Skillstore immutable audit report identifier"
Skillstore Score
Why this score Evidence Confidence: HighWhat You Can Build
Design a new REST API from scratch
A backend developer uses the skill to structure endpoints, pick status codes, and define request and response formats for a new service.
Review an existing API contract
A tech lead asks the skill to check an API against the validation checklist for consistency, correct methods, and pagination.
Write an OpenAPI specification
An API documentation writer uses the OpenAPI template to produce a complete and valid specification for stakeholders.
Try These Prompts
Design REST endpoints for managing a 'products' resource. Include list, get, create, update, and delete operations with the correct HTTP methods and status codes.
Define consistent JSON success, paginated list, and error response formats for my user management API.
Recommend a versioning strategy and an authentication pattern for a public API that will have external consumers.
Create a complete OpenAPI 3.0 specification for an orders API with endpoints for listing, creating, and retrieving orders, including request bodies, responses, and schemas.
Best Practices
- Use resource-based URLs with nouns and match HTTP methods to operations.
- Keep response formats consistent across every endpoint, including errors.
- Document the design with a complete OpenAPI specification before implementation.
Avoid
- Do not put verbs in URLs, such as /getUser or /createUser.
- Do not return the same 200 status code for every response regardless of outcome.
- Do not place sensitive data such as tokens or passwords in URLs or query strings.
Frequently Asked Questions
Does this skill write the API code for me?
Does it support both REST and GraphQL?
Which versioning strategy does it recommend?
Can it help me write an OpenAPI specification?
Does it cover authentication?
Is this skill safe to install?
Developer Details
Author
CloudAI-XLicense
MIT
Skillstore revision
r2
Version notice
The author did not declare a version.
Ref
c68df504887c54bf71d2d467a1fbebde49467868
Maintenance freshness
7/19/2026
Usage
5 downloads · 212 views
File structure