speckit.product-forge.api-docs

speckit.product-forge.api-docs is a command for coding agents from VaiYav/speckit-product-forge. It costs 82 tokens per session (4,184 once invoked), scanned A, original, MIT.

An API documentation command that turns planned API contracts into an OpenAPI 3.1 specification and a Postman collection. OpenAPI is a standard format for describing how software APIs work, while Postman is a tool for testing API requests.

In plain words
What is it for?
Use it after implementation to document backend endpoints, check that their contracts match the code, and produce files ready to publish or test.
Why use it?
It removes the need to write API documentation by hand and helps find differences between the documented API, frontend calls, and backend code.

Command

Part of the speckit-product-forge plugin — 31 commands shipped together

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add commands/vaiyav/speckit-product-forge/api-docs
Clone the repo
git clone --depth 1 https://github.com/VaiYav/speckit-product-forge

Or install speckit-product-forge, the plugin that ships this one along with the rest of its 31 commands.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for speckit.product-forge.api-docs

README.md
[![agentmods](https://agentmods.dev/badge/commands/vaiyav/speckit-product-forge/api-docs.svg)](https://agentmods.dev/commands/vaiyav/speckit-product-forge/api-docs)
Your own site
<a href="https://agentmods.dev/commands/vaiyav/speckit-product-forge/api-docs"><img src="https://agentmods.dev/badge/commands/vaiyav/speckit-product-forge/api-docs.svg" alt="Measured on agentmods" height="20"></a>
Per session 82 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 4,184 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00082 $0.04184
Opus 5 $0.00041 $0.02092
Sonnet 5 $0.00016 $0.00837
Haiku 4.5 $0.00008 $0.00418

Measured 4d ago against content hash 32a22b35b34c, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

speckit.product-forge.api-docs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 4d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

commands/api-docs.md · 521 lines

How it starts

The opening of the file, as written. The whole thing — 521 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Product Forge — API Docs Generation

You are the API Documentation Generator for Product Forge. Your goal: extract API contracts from feature artifacts and generate production-ready OpenAPI 3.1 spec and a Postman collection — automatically, with no manual writing.

User Input

$ARGUMENTS

Contract-first (v1.6, Theme F): when contracts/openapi.yaml / contracts/asyncapi.yaml already exist (authored in bridge/plan), this command validates and regenerates against them and the implementation rather than authoring contracts from scratch. Report drift between the contract, the FE client calls, and the BE handlers as findings (feeds verify-full Layer 9).

Step 1: Validate Prerequisites

  1. Read .forge-status.ymlimplement must be completed (Phase 6 done)
  2. Verify plan.md exists and contains API endpoint definitions
  3. Verify spec.md exists; load contracts/openapi.yaml + contracts/asyncapi.yaml if present

If no API endpoints found in plan.md:

ℹ️ No API endpoints detected in plan.md. This command generates docs for backend APIs. If this is a frontend-only feature, api-docs is not needed.


Step 2: Auto-detect API Framework

Scan the codebase to understand the API framework:

🔍 Detecting API framework...

Detect:

  1. Authoritative contracts (check first):
    • Look for: {FEATURE_DIR}/contracts/openapi.yaml (HTTP) and {FEATURE_DIR}/contracts/asyncapi.yaml (events), authored in bridge/plan.
    • If present, these are the authoritative input — this command validates and regenerates against them + the implementation, it does not re-author from scratch.
  2. Framework: NestJS / Express / FastAPI / Django REST / Rails / other
    • Look for: nest-cli.json, @nestjs/swagger, express, fastapi, rest_framework
  3. Existing OpenAPI setup:
    • Look for: swagger.json, openapi.yml, @ApiProperty decorators (NestJS)
  4. Base path / versioning:
    • Look for: app prefix in main.ts, globalPrefix, version in URL patterns
  5. Auth scheme:
    • Look for: JWT guards, API key headers, OAuth2 config, @ApiBearerAuth()
  6. Existing DTO/schema files:
    • Look for: *.dto.ts, *.schema.ts, Zod schemas, Pydantic models

Read the full file on GitHub · 521 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 4d ago First seen · 521 lines · 82 tokens per session scan A 32a22b35b34c

Subscribe to this mod's changes

speckit.product-forge.api-docs is a command published in the GitHub repository VaiYav/speckit-product-forge (23 stars, last pushed 10d ago), licensed MIT. It adds 82 tokens to every session and 4,184 once invoked, about $0.0004 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.