Skills api-contract-design

📦

api-contract-design

Name: api-contract-design
Author: Doyajin174

v1.0 Content revision r1 Safe ⚙️ External commands🌐 Network access📁 Filesystem access🔑 Env variables

Design Schema-First OpenAPI Contracts

API teams lose time when contracts are unclear or written after implementation. This skill guides OpenAPI-first design, TypeScript generation, validation, documentation, and mock workflows.

Supports: Claude Codex Code(CC)

🥉 77 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-contract-design" from https://skillstore.io/skills/doyajin174-api-contract-design.md and its manifest at https://skillstore.io/api/skills/doyajin174-api-contract-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.

Markdown detail GET /skills/doyajin174-api-contract-design.md Signed manifest GET /api/skills/doyajin174-api-contract-design/manifest Signed lockfile GET /api/skills/doyajin174-api-contract-design/lockfile

Test it

Using "api-contract-design". A team needs a user management API before backend work starts.

Expected outcome:

OpenAPI contract outline with user, authentication, pagination, and error sections.
Review checklist for frontend and backend teams.
Type generation plan for shared client models.

Using "api-contract-design". A legacy service lacks typed clients.

Expected outcome:

A migration plan that maps endpoints to OpenAPI operations, then generates TypeScript types and a client.

Using "api-contract-design". Frontend development is blocked by missing backend endpoints.

Expected outcome:

A mock server workflow using the contract, shared examples, and review steps for API changes.

Security Audit

Safe

v8 • 7/6/2026 Open versioned report

All static findings were adjudicated as false positives in documentation examples, reference links, or OpenAPI schema snippets. No prompt injection, credential exfiltration, unauthorized command execution, or malicious network intent was found in SKILL.md or marketplace.json.

Files scanned

620

Lines analyzed

Review items

False positives ignored

Risk Factors

⚙️ External commands (41)

🌐 Network access (9)

SKILL.md:312 SKILL.md:39 SKILL.md:41 SKILL.md:446 SKILL.md:447 SKILL.md:513 SKILL.md:514 SKILL.md:515 SKILL.md:516

📁 Filesystem access (2)

SKILL.md:271 SKILL.md:273

🔑 Env variables (2)

SKILL.md:324 SKILL.md:324

No confirmed security findings were detected by the latest completed static and semantic audit. This does not prove the skill has no side effects.

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/doyajin174-api-contract-design/audits/8?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown badge

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

HTML badge

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

Embed card

<iframe src="https://skillstore.io/embed/skills/doyajin174-api-contract-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

Doyajin174. (2026). api-contract-design security audit report (audit version 8) [Author version 1.0]. Skillstore. https://skillstore.io/skills/doyajin174-api-contract-design/audits/8

BibTeX citation

@techreport{doyajin174-doyajin174-api-contract-design-2026,
  author = {Doyajin174},
  title = {api-contract-design security audit report (audit version 8)},
  institution = {Skillstore},
  year = {2026},
  number = {8},
  url = {https://skillstore.io/skills/doyajin174-api-contract-design/audits/8},
  note = {Author version 1.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-contract-design security audit report (audit version 8)"
version: "1.0"
type: report
authors:
  - name: "Doyajin174"
date-released: "2026-07-06"
url: "https://skillstore.io/skills/doyajin174-api-contract-design/audits/8"
identifiers:
  - type: other
    value: "skillstore:doyajin174-api-contract-design:audit:8"
    description: "Skillstore immutable audit report identifier"

Skillstore Score

Why this score Evidence Confidence: High

Architecture

Maintainability

Content

Community

Spec Compliance

What You Can Build

Plan a New Product API

Define endpoints, data models, error responses, and client types before implementation begins.

Document an Existing REST Service

Convert current behavior into an OpenAPI contract that teams can review and maintain.

Standardize Service Contracts

Create consistent patterns for pagination, errors, versioning, validation, and generated SDKs across services.

Try These Prompts

Create a Basic Contract

Design an OpenAPI 3.1 contract for a todo API. Include CRUD endpoints, request schemas, responses, and common errors.

Add Type Generation

Extend this API contract with reusable schemas and operation IDs. Explain how to generate TypeScript types and validate requests.

Design Team Workflow

Create a schema-first workflow for frontend and backend teams. Include mock server use, reviews, versioning, and documentation publishing.

Audit a Large Contract

Review this OpenAPI contract for maintainability, breaking changes, duplicated schemas, weak validation, and code generation risks. Suggest prioritized improvements.

Best Practices

Agree on operation IDs, response shapes, and error models before implementation starts.
Keep large contracts modular with reusable schemas, responses, and path references.
Review API contracts like production code before generating clients or SDKs.

Avoid

Do not mix schema-first and code-first sources without a clear ownership rule.
Do not hide breaking changes behind version labels without migration notes.
Do not generate clients from unreviewed contracts or stale specifications.

Frequently Asked Questions

Does this skill run OpenAPI tools automatically?

No. It explains commands and patterns, but tool execution needs explicit user action.

Which OpenAPI version does it target?

It focuses on OpenAPI 3.1, while many patterns also apply to OpenAPI 3.0.

Can it help with existing APIs?

Yes. It can help describe current endpoints as a contract for review and documentation.

Does it replace backend validation?

No. It outlines validation patterns, but applications must enforce validation at runtime.

Can Claude, Codex, or Claude Code use it?

Yes. The report marks support for Claude, Codex, and Claude Code workflows.

Is it useful for generated clients?

Yes. It explains operation IDs, reusable schemas, and generation workflows for typed clients.

Developer Details

Author

Doyajin174

License

MIT

Author version

v1.0

Skillstore revision

Version notice

The author-declared version is not valid SemVer.

Repository

https://github.com/Doyajin174/myskills/tree/main/.public/skills/api-contract-design

Ref

72d5025b022c77f7a51bdf5c1637c689c80e89d1

Maintenance freshness

7/20/2026

Usage

6 downloads · 261 views

File structure

📄 marketplace.json

📄 SKILL.md