openapi-endpoint-indexer

Build a sorted index of paths and methods from an OpenAPI JSON document the user provides. Use when surveying an API surface area.

Purpose / Overview

Lists METHOD path lines sorted by path from OpenAPI 3 JSON.

When to Use

API reviews; generating smoke-test checklists.

Usage / Instructions

1. Accept OpenAPI JSON (paste or file path).
2. Walk paths → methods.
3. Print GET /v1/foo style lines; count totals by method.

Examples

Small petstore-like spec → indexed method list.

Requirements / Dependencies

None for pasted JSON; read file only if path given.

Limitations / Caveats

Ignores webhooks/callbacks sections.

Security / Permissions

Local read of user-provided content only. No live calls to the API.

Description

Build a sorted index of paths and methods from an OpenAPI JSON document the user provides.

License or terms

MIT-0

Use case

Intended for practitioners who need help with: Build a sorted index of paths and methods from an OpenAPI JSON document the user provides.

Risks and mitigations

References

• OpenAPI Specification: https://spec.openapis.org/oas/latest.html

Ethical considerations

Use that is illegal under local or international law is not permitted. The publisher will not be accountable for misuse enabled by this skill. Examples of unacceptable use include unauthorized data exfiltration, copyright piracy operations, and assisting financial crime. Do not use it to generate instructions for committing crimes.