write-api-docs

You can generate API reference documentation by providing the API source path to parse source files, route definitions, and endpoint implementations into structured, comprehensive docs.

Cross-reference OpenAPI specs with your codebase by parsing both source files and definitions to align endpoint implementations with the API contract, ensuring accuracy and reducing drift.

Yes, you can inventory endpoints by resource and method across multiple REST/HTTP services, organizing them into structured documentation suitable for developer portals and internal docs.

You do not strictly need OpenAPI specs; the documentation can be generated from code, OpenAPI specs, or endpoint implementations, and supports manual overrides for alignment.

Create an endpoint inventory by parsing route definitions and source files to map REST/HTTP endpoints by resource and method, producing a structured inventory aligned with the API contract.

Documentation may misalign with implementations due to drift; cross-referencing OpenAPI specs with source code ensures alignment, and manual overrides can correct discrepancies in the generated docs.