openapi-inspect

OpenAPI Endpoint Inspector

Fetch and display full details for a specific API endpoint from a running service's OpenAPI spec.

Instructions

Use {host} as the base URL. Default to http://localhost:8000 if the user does not specify a host.

1. Fetch endpoint details

Pull the endpoint entry from the OpenAPI spec using jq:

curl -s {host}/openapi.json | jq '.paths["/path/to/endpoint"]'

Replace "/path/to/endpoint" with the actual path the user asked about.

2. Find $ref references

Scan the output for any "$ref": "#/components/schemas/SchemaName" entries. Collect every unique schema name.

3. Resolve referenced schemas

For each $ref, query its schema and recursively resolve nested $ref entries until all schemas are fully expanded:

curl -s {host}/openapi.json | jq '.components.schemas.SchemaName'

Replace SchemaName with the name extracted from the $ref.

4. Present the results

Display to the user:

• HTTP methods available on the endpoint (GET, POST, etc.)
• Request parameters (path, query, header)
• Request body schema (fully resolved, not just the $ref)
• Response schemas for each status code (fully resolved)
• Any example values found in the spec