Skills api-design-principles

📦

api-design-principles

Name: api-design-principles
Author: sickn33

Content revision r1 Safe 🌐 Network access⚙️ External commands

Design Better REST and GraphQL APIs

API teams need consistent contracts that are easy to use and maintain. This skill guides REST and GraphQL design with templates, checklists, and review criteria.

Supports: Claude Codex Code(CC)

🥉 78 Bronze

Install with my Agent

Copy this request to your Agent. It includes the canonical Skill page and manifest.

Agent request

Review the Skillstore skill "api-design-principles" from https://skillstore.io/skills/sickn33-api-design-principles.md and its manifest at https://skillstore.io/api/skills/sickn33-api-design-principles/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.

Markdown detail GET /skills/sickn33-api-design-principles.md Signed manifest GET /api/skills/sickn33-api-design-principles/manifest Signed lockfile GET /api/skills/sickn33-api-design-principles/lockfile

Test it

Using "api-design-principles". A team needs a user management REST API design review.

Expected outcome:

Resource naming recommendations for users, roles, and invitations.
Status code guidance for create, update, delete, and validation failures.
Pagination, filtering, error response, and versioning review notes.

Using "api-design-principles". A product team needs a GraphQL schema for orders and customers.

Expected outcome:

Type and connection structure recommendations.
Mutation payload guidance with structured errors.
Performance notes for batching, query depth, and resolver boundaries.

Using "api-design-principles". A platform team wants reusable API standards.

Expected outcome:

A concise review checklist for design proposals.
Rules for naming, pagination, authentication, errors, and documentation.
Common anti-patterns to block during contract review.

Security Audit

Safe

v6 • 7/9/2026 Open versioned report

Most static detections are false positives in documentation examples, checklists, and Markdown resource references. The only confirmed issue is a FastAPI template that binds uvicorn to all interfaces. No prompt injection, data exfiltration, or malicious intent was found.

Files scanned

1,892

Lines analyzed

Review items

False positives ignored

Capability review items (1)

These are real local capabilities that may be expected for this skill, so they require review but are not counted as confirmed malicious behavior.

Medium

assets/rest-api-template.py:182

Hardcoded IP address

uvicorn.run(app, host="0.0.0.0", port=8000)

The template starts uvicorn on 0.0.0.0, which binds to all interfaces if a user runs it. This can expose a sample API outside localhost unless the environment is controlled.

Risk Factors

🌐 Network access (6)

assets/rest-api-template.py:182 references/rest-best-practices.md:143 references/rest-best-practices.md:144 references/rest-best-practices.md:145 references/rest-best-practices.md:146 references/rest-best-practices.md:347

⚙️ External commands (2)

SKILL.md:36 SKILL.md:40

Audited by: codex View Audit History →

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.

Open versioned report

Copy report link

https://skillstore.io/skills/sickn33-api-design-principles/audits/6?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown badge

[![Skillstore security assessment](https://skillstore.io/badges/skills/sickn33-api-design-principles/security.svg)](https://skillstore.io/skills/sickn33-api-design-principles?utm_source=security_passport_badge)

HTML badge

<a href="https://skillstore.io/skills/sickn33-api-design-principles?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/sickn33-api-design-principles/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

Embed card

<iframe src="https://skillstore.io/embed/skills/sickn33-api-design-principles.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-design-principles security audit report (audit version 6) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-api-design-principles/audits/6

BibTeX citation

@techreport{sickn33-sickn33-api-design-principles-2026,
  author = {sickn33},
  title = {api-design-principles security audit report (audit version 6)},
  institution = {Skillstore},
  year = {2026},
  number = {6},
  url = {https://skillstore.io/skills/sickn33-api-design-principles/audits/6},
  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-principles security audit report (audit version 6)"
version: "unspecified"
type: report
authors:
  - name: "sickn33"
date-released: "2026-07-09"
url: "https://skillstore.io/skills/sickn33-api-design-principles/audits/6"
identifiers:
  - type: other
    value: "skillstore:sickn33-api-design-principles:audit:6"
    description: "Skillstore immutable audit report identifier"

Compare variants

2 installable variants

Each author remains a separate installable skill. The recommended variant is ranked by Skillstore evidence.

Why this variant is first

Highest Skillstore Score

Author / source Skillstore Score Evidence Confidence Skillstore usage Updated

sickn33 Recommended Current

sickn33-api-design-principles

Skillstore Score 78

Evidence Confidence High

Skillstore usage 11

Updated

2026-08-21

wshobson

wshobson-api-design-principles

Skillstore Score 70

Evidence Confidence High

Skillstore usage 16

Updated

2026-08-21

Skillstore Score

Why this score Evidence Confidence: High

Architecture

Maintainability

Content

Community

Spec Compliance

What You Can Build

Plan a New Public API

Define resources, schemas, errors, pagination, and versioning before implementation begins.

Review an Existing Contract

Check REST or GraphQL designs for consistency, usability, security posture, and documentation gaps.

Create Team Standards

Turn design guidance into reusable API rules, review checklists, and onboarding material.

Try These Prompts

Choose an API Style

Help me choose REST or GraphQL for this service. Consumers: [list]. Core use cases: [list]. Constraints: [latency, clients, auth, team skills].

Draft REST Resources

Design REST resources for [domain]. Include resource names, methods, status codes, pagination, filtering, error format, and versioning guidance.

Review a GraphQL Schema

Review this GraphQL schema for naming, nullability, pagination, mutation payloads, errors, authorization boundaries, and N+1 risks: [schema summary].

Create an API Governance Checklist

Create a practical API design checklist for our team. Cover REST, GraphQL, auth, errors, docs, observability, versioning, and review gates.

Best Practices

Start with consumers, use cases, and constraints before choosing REST or GraphQL.
Keep API contracts consistent across naming, errors, pagination, authentication, and versioning.
Validate designs with examples, review checklists, and implementation constraints before release.

Avoid

Choosing GraphQL or REST based only on preference instead of consumer needs.
Shipping inconsistent error formats, status codes, or pagination behavior across endpoints.
Copying sample templates into production without security and environment review.