generate-api-docs

You can automatically generate REST API documentation by providing a ProjectModel JSON to a renderer that derives markdown docs directly from your codebase, ensuring endpoint consistency without manual writing.

Yes, you can sync API docs using a 2-step workflow that scans your codebase for API changes, proposes deltas to existing markdown documentation, and applies those updates to keep everything aligned.

To update existing markdown API docs, you apply a Delta representing API changes to your current documentation, which patches the markdown to reflect new or modified endpoints accurately.

Yes, the API documentation generator supports single-language output in JP, EN, or VN, allowing you to produce localized markdown documentation tailored to your specific regional requirements.

The best way to maintain OpenAPI documentation is automating generation from a ProjectModel JSON and using codebase scanning to propose and apply delta updates, keeping docs synced with code changes.

Yes, you need a ProjectModel JSON because the renderer relies on it as the structural source to automatically generate and update your comprehensive REST API documentation from the codebase.