MightyMouse

Playbooks · Developer tool

Publish an OpenAPI spec and collection

Developers can try every endpoint without writing code first.

Developer toolEngineeringapidocsopenapi

Run it on my project

The number it moves

Minutes to first success

Time from landing on the docs to a first working API call or command (time to first call).

What your AI does

Search for openapi.yaml/json, swagger, or route definitions. If no spec exists, propose generating one from the routes or types and a ready-to-import collection. If one exists, check it matches the live routes and has examples for each response.

Done when

  1. An OpenAPI spec exists
  2. It matches the live routes
  3. Every response has an example and a ready-to-import collection exists

The prompt

Paste this into any AI coding tool, or run it in MightyMouse and your AI works on your own project.

Publish an OpenAPI spec and collection (Developer tool)

Search for openapi.yaml/json, swagger, or route definitions. If no spec exists, propose generating one from the routes or types and a ready-to-import collection. If one exists, check it matches the live routes and has examples for each response.

Done when:
- An OpenAPI spec exists
- It matches the live routes
- Every response has an example and a ready-to-import collection exists

Read the code first. If it already does this well, change nothing and say so. Otherwise make the smallest change that makes every line above true.

Work with what this project already uses. Do not add a paid tool or service unless I ask for one.

Playbook: https://getmightymouse.com/playbooks/devtool-publish-an-openapi-spec-and-collection/ - published by MightyMouse. Source: OpenAPI Initiative, https://learn.openapis.org/

The skill file

Save this as SKILL.md and Claude Code or Cursor can run the playbook any time you ask.

---
name: devtool-publish-an-openapi-spec-and-collection
description: Developers can try every endpoint without writing code first. Use on a developer tool project to improve "Minutes to first success".
---

# Publish an OpenAPI spec and collection

Search for openapi.yaml/json, swagger, or route definitions. If no spec exists, propose generating one from the routes or types and a ready-to-import collection. If one exists, check it matches the live routes and has examples for each response.

## Done when

- [ ] An OpenAPI spec exists
- [ ] It matches the live routes
- [ ] Every response has an example and a ready-to-import collection exists

## How to run it

Read the code first and tick every line that is already true. If all are true, change nothing and say so. Otherwise make the smallest change that makes the rest true, then report each line as done or not done.

Work with what this project already uses. Do not add a paid tool or service unless I ask for one.

Playbook: https://getmightymouse.com/playbooks/devtool-publish-an-openapi-spec-and-collection/ - published by MightyMouse. Source: OpenAPI Initiative, https://learn.openapis.org/

More developer tool playbooks