api-design
Design Better REST and GraphQL APIs
API teams need consistent contracts before implementation starts. This skill guides resource design, request formats, errors, versioning, 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/supercent-io-api-design.md and its manifest at https://skillstore.io/api/skills/supercent-io-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 a user management API for account profiles and roles.
Expected outcome:
- A resource map for users, roles, and memberships.
- Endpoint descriptions with methods, status codes, and validation notes.
- A consistent error response model and pagination strategy.
Using "api-design". Review a product catalog API before frontend integration.
Expected outcome:
- A checklist of naming, filtering, sorting, and caching issues.
- Recommended endpoint changes with compatibility notes.
- Documentation gaps that may block frontend or partner teams.
Using "api-design". Decide whether an analytics dashboard should use REST or GraphQL.
Expected outcome:
- A comparison of query flexibility, caching, schema evolution, and client complexity.
- A recommended architecture with risks and migration considerations.
Security Audit
SafeAll static findings are false positives from Markdown API examples, HTTP status labels, and public documentation links. I found no executable scripts, no runtime network calls, and no prompt injection text in the reviewed files. No semantic security findings were identified.
Risk Factors
⚙️ External commands (50)
🌐 Network access (5)
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/supercent-io-api-design/audits/4?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown badge
[](https://skillstore.io/skills/supercent-io-api-design?utm_source=security_passport_badge)HTML badge
<a href="https://skillstore.io/skills/supercent-io-api-design?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/supercent-io-api-design/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Embed card
<iframe src="https://skillstore.io/embed/skills/supercent-io-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
supercent-io. (2026). api-design security audit report (audit version 4) [Author version 1.0.0]. Skillstore. https://skillstore.io/skills/supercent-io-api-design/audits/4BibTeX citation
@techreport{supercent-io-supercent-io-api-design-2026,
author = {supercent-io},
title = {api-design security audit report (audit version 4)},
institution = {Skillstore},
year = {2026},
number = {4},
url = {https://skillstore.io/skills/supercent-io-api-design/audits/4},
note = {Author version 1.0.0}
}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 4)"
version: "1.0.0"
type: report
authors:
- name: "supercent-io"
date-released: "2026-07-07"
url: "https://skillstore.io/skills/supercent-io-api-design/audits/4"
identifiers:
- type: other
value: "skillstore:supercent-io-api-design:audit:4"
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
Define resources, endpoints, status codes, and response shapes before implementation begins.
Review an Existing API Contract
Find naming, pagination, error, and versioning inconsistencies in a current API design.
Prepare Developer Documentation
Turn endpoint requirements into clear OpenAPI-oriented documentation and integration examples.
Try These Prompts
Design REST endpoints for a {resource} resource. Include methods, paths, status codes, and simple request and response descriptions.Design list endpoints for {resource}. Include pagination, filtering, sorting, field selection, and example error cases.Create an OpenAPI-oriented outline for {service}. Include endpoints, schemas, authentication, errors, and versioning guidance.Evaluate REST and GraphQL designs for {domain}. Recommend one approach and explain tradeoffs for data shape, caching, auth, and versioning.Best Practices
- Start with clear resources, relationships, and authorization rules before naming endpoints.
- Keep response, error, pagination, and versioning patterns consistent across services.
- Document schemas and examples alongside endpoint decisions so contracts stay reviewable.
Avoid
- Mixing verbs and nouns in paths without a consistent resource model.
- Adding custom error shapes for each endpoint without shared codes and fields.
- Choosing GraphQL only to hide unclear resource boundaries or authorization rules.
Frequently Asked Questions
Does this skill generate production API code?
Can it help with OpenAPI documents?
Does it support GraphQL design?
Can it review existing endpoints?
Does it make live network calls?
Which tools can use this skill?
Developer Details
Author
supercent-ioLicense
Apache-2.0
Author version
v1.0.0
Skillstore revision
r1
Ref
f93e9bb0daca99badb6a7e574b97737155d57cb3
Maintenance freshness
7/18/2026
Usage
15 downloads · 104 views
File structure
📄 SKILL.md