skills.rest
legioncodeinc
legioncodeincOFFICIAL
Explore all skills by this author →
WebsiteGitHub

api-docs-stinger

Generates API documentation, SDKs, and changelogs from OpenAPI specifications.

84|37|Updated May 23, 2026
Search Tags:#changelog#openapi#api documentation#github pages#sdk generation#scalar#redoc
One-click install
npx skills add https://github.com/legioncodeinc/vibe-coding-tools --skill api-docs-stinger-legioncodeinc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-docs-stinger
Source: https://github.com/legioncodeinc/vibe-coding-tools/tree/main/src/skills/api-docs-stinger
Command: npx skills add https://github.com/legioncodeinc/vibe-coding-tools --skill api-docs-stinger-legioncodeinc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Teams struggle to choose the right API documentation renderer, keep OpenAPI specs enriched with examples, generate client SDKs, and communicate breaking changes without breaking consumer trust. This Skill encodes the complete decision-making and execution playbook for turning a raw OpenAPI spec into a published developer experience. ## Core Features & Use Cases - Renderer Selection: Compares Scalar, Redoc, Swagger UI, Mintlify, Stoplight, and Bump.sh with a decision tree and migration cost estimates. - Spec Enrichment & Deployment: Guides JSON example authoring (inline, named, x-codeSamples, overlays) and deployment to GitHub Pages, Netlify, Vercel, or self-hosted Docker. - SDK Generation & Changelog Discipline: Covers openapi-generator-cli, Fern, and Speakeasy for TypeScript/Python/Go, plus the [BREAKING] changelog convention with Bump.sh CI diff gates. - Use Case: Given an existing openapi.yaml, select Scalar as the renderer, deploy it to GitHub Pages via a GitHub Actions workflow, generate a TypeScript SDK, and write a compliant changelog entry for a breaking endpoint rename. ## Quick Start Ask the assistant to set up API documentation for your OpenAPI spec, for example by saying: set up Scalar docs for my openapi.yaml and deploy them to GitHub Pages.

Frequently Asked Questions about api-docs-stinger

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I choose between Scalar, Redoc, and Swagger UI for API docs?▼

Scalar is the recommended default for new projects in 2026, offering a built-in interactive console, theming, and full OpenAPI 3.1 support. Redoc suits enterprise teams wanting a proven three-panel read-only layout, while Swagger UI remains for legacy deployments where migration is not justified.

How do I generate a TypeScript SDK from an OpenAPI spec?▼

Run openapi-generator-cli with the typescript-axios generator against your spec, or use Fern or Speakeasy for more idiomatic output. Ensure every operation has an operationId and schemas use $ref components before generating for best results.

How do I deploy OpenAPI docs to GitHub Pages?▼

Commit a docs/index.html that embeds Scalar via CDN pointing at your openapi.yaml, then add a GitHub Actions workflow that copies the spec and deploys with actions/deploy-pages. Note that free GitHub plans only support Pages from public repositories.

What counts as a breaking API change in a changelog?▼

Breaking changes include removing or renaming endpoints, fields, or parameters, changing field types, making a property required, removing enum values, or changing authentication schemes. Every such change must be prefixed with [BREAKING] and include migration steps and a deprecation timeline.

Fern vs openapi-generator-cli: which SDK generator should I use?▼

Fern produces more idiomatic TypeScript and Python SDKs but costs $250 per month per SDK after the free OSS tier and was acquired by Postman in January 2026. openapi-generator-cli is free with 50+ language targets but requires a Java runtime and carries a large open-issue backlog.

When should I not use this API documentation workflow?▼

Do not use it for general narrative documentation sites, which belong to a documentation-site skill, or for OpenAPI security scheme audits and REST/GraphQL route design. It covers only the API reference layer derived from the spec.

Related Skills

Explore More Software Engineering Skills→
CaptainPhantasyCaptainPhantasy

api-swagger-doc

Generate OpenAPI 3.0 specification fragments from route handler code comments.

Community
Intermediate
AI-RiksarkivetAI-Riksarkivet
2

building-with-dagger

Automate Go-based CI/CD workflows with the Dagger SDK.

Official
Advanced
vikisingh23vikisingh23
4

api-testing

Generate and validate Postman/Newman test collections from OpenAPI/Swagger specs.

Community
Intermediate
bomberoxenviosdosruedasbomberoxenviosdosruedas

agency-unreal-technical-artist

Optimize Unreal Engine materials, Niagara VFX, PCG graphs, and LOD systems.

Community
Advanced