api-patterns
Design Reliable APIs with Proven Patterns
Choosing an API style and consistent conventions requires many connected decisions. This skill provides focused guidance for design, security, evolution, validation, 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-patterns" from https://skillstore.io/skills/sickn33-api-patterns.md and its manifest at https://skillstore.io/api/skills/sickn33-api-patterns/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-patterns". Recommend an API style for a public service used by web, mobile, and partner clients.
Expected outcome:
- Recommendation: REST with OpenAPI offers broad compatibility and clear client contracts.
- Use versioned public routes, cursor pagination, consistent errors, and documented rate limits.
- Confirm data complexity and real-time needs before finalizing the design.
Using "api-patterns". Review pagination for a large, frequently changing transaction dataset.
Expected outcome:
- Prefer cursor pagination because offsets can become unstable as records change.
- Use a stable sortable field and return an opaque next-page cursor.
- Document ordering, page limits, and cursor expiration behavior.
Using "api-patterns". Create a security review checklist for a new GraphQL API.
Expected outcome:
- Verify field-level authorization and restrict production introspection where appropriate.
- Set query depth, complexity, and batch limits to control resource consumption.
- Test authentication, input handling, rate limits, error exposure, and third-party data trust.
Security Audit
SafeAll 20 static findings are false positives caused by Markdown text, reference formatting, or legitimate API security-testing guidance. No prompt injection, malicious command execution, network activity, or data-exfiltration intent was found.
Risk Factors
⚙️ External commands (14)
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/sickn33-api-patterns/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown badge
[](https://skillstore.io/skills/sickn33-api-patterns?utm_source=security_passport_badge)HTML badge
<a href="https://skillstore.io/skills/sickn33-api-patterns?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/sickn33-api-patterns/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Embed card
<iframe src="https://skillstore.io/embed/skills/sickn33-api-patterns.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
sickn33. (2026). api-patterns security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-api-patterns/audits/5BibTeX citation
@techreport{sickn33-sickn33-api-patterns-2026,
author = {sickn33},
title = {api-patterns security audit report (audit version 5)},
institution = {Skillstore},
year = {2026},
number = {5},
url = {https://skillstore.io/skills/sickn33-api-patterns/audits/5},
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-patterns security audit report (audit version 5)"
version: "unspecified"
type: report
authors:
- name: "sickn33"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/sickn33-api-patterns/audits/5"
identifiers:
- type: other
value: "skillstore:sickn33-api-patterns:audit:5"
description: "Skillstore immutable audit report identifier"
Skillstore Score
Why this score Evidence Confidence: HighWhat You Can Build
Select an API Style
Compare API approaches against client diversity, data complexity, caching, language, and deployment constraints.
Standardize Service Contracts
Define consistent resources, status codes, errors, pagination, authentication, rate limits, and versioning.
Review API Readiness
Assess documentation, OpenAPI files, implementation signals, and defensive security controls before release.
Try These Prompts
Compare REST, GraphQL, and tRPC for my project. Ask about consumers, languages, data relationships, caching, and public access before recommending one.
Design a REST contract for [domain]. Define resources, methods, status codes, error responses, pagination, authentication, and rate limiting.
Review this API design for compatibility risks. Recommend versioning, deprecation, documentation, and migration practices based on its consumers and release constraints.
Audit [project path or specification] for design consistency, OpenAPI completeness, authentication, authorization, validation, rate limiting, GraphQL risks, and release blockers.
Best Practices
- Identify consumers, languages, data relationships, and operational constraints before choosing an API style.
- Keep response, error, pagination, authentication, and versioning conventions consistent across the service.
- Combine automated checks with authorized testing, framework-aware review, and complete documentation.
Avoid
- Do not default to REST without evaluating consumers, data complexity, and type-safety requirements.
- Do not expose internal errors or return inconsistent response structures.
- Do not release an API without authentication review, rate limits, documentation, and an evolution plan.