api-documentation

To auto-generate API documentation, run the documentation generator to scan your controllers and DTOs and refresh the docs. The skill integrates with the project build and Swagger configuration to produce accessible API references.

To keep Swagger or OpenAPI references in sync, run the documentation generator after adding a new endpoint or evolving DTOs. It automatically updates the docs to match the latest codebase changes and publishes them to the internal docs portal.

You need XML comments on controllers and DTO annotations integrated with the build pipeline to produce accessible API docs. The skill satisfies these requirements to generate comprehensive Swagger/OpenAPI references for client integration.

Yes, you can use this for maintaining API documentation across a large e-commerce backend codebase. It automates the generation and upkeep of docs, reducing manual drafting and ensuring they stay synchronized with new endpoints and evolving DTOs.

The best way to document new endpoints without manual drafting is running the documentation generator. It scans the API, refreshes the Swagger/OpenAPI references, and publishes the updated comprehensive docs to your internal portal.

You should not rely on automated API documentation generation when your controllers lack XML comments or DTOs lack annotations. The skill requires these inputs, along with build pipeline integration, to synchronize updates and produce valid OpenAPI references.