Endpoint inventory
Turns nested OpenAPI path objects into a compact, predictably sorted list of HTTP operations.
Day 040 / APIs / OpenAPI
OpenAPI Endpoint Index
/ Overview
A dependency-free Python CLI that turns a local OpenAPI 3.x JSON document into a deterministic, review-friendly endpoint catalog.
OpenAPI documents can grow large enough that answering a basic question—what operations exist and how are they grouped—requires scanning deeply nested JSON. A useful inventory should stay concise and avoid executing requests or copying payload examples.
/ Provided servicesClear thinking.
Clear thinking.
Practical delivery.
Focused metadata
Keeps operation IDs, summaries, tags, counts, response codes and deprecation flags without including example payload values.
Read-only boundaries
Accepts only a local JSON file, enforces size and operation limits, and performs no network or API requests.
/ Solution
OpenAPI Endpoint Index validates a bounded local OpenAPI 3.x JSON document, extracts its HTTP operations and produces a stable catalog of method, path, operation ID, summary, tags, parameter count, response codes and deprecation state. It writes readable text or JSON, never fetches remote documents and never calls an API.
/ Impact
Deterministic method-and-path catalog
OpenAPI 3.x validation
Allowlisted operation metadata
Two-megabyte input boundary
Up to 500 indexed operations
Text and JSON reports
Ten standard-library tests included
Python standard library
Argparse, pathlib, collections and JSON provide the complete dependency-free command-line workflow.
OpenAPI 3.x
Indexes standard path-item operations while ignoring non-method keys such as shared parameters.
Unittest
Ten tests cover ordering, metadata, malformed documents, size and endpoint limits, readable output and CLI JSON output.