Engineering
Code review assistant
Connects to your code repositories and checks every merge request for security, performance and coding standards, with suggestions you can apply as-is.
- Cross-industry
Engineering
API documentation generator
Generates and maintains API documentation from code and comments, updates it whenever an interface changes, and includes call examples.
Sample input and output
Sample input
(Connect the order service repository)
Sample output
Generated documentation for 42 endpoints, including request and response examples and 18 error code descriptions. 3 endpoints are incompatible with the previous version and have been flagged in the change notes.
Details
Outdated API documentation is the most common source of friction between teams. This template reads route definitions, types and comments from the code repository, generates an OpenAPI specification and readable documentation, and automatically updates the affected sections in any merge request that changes an interface.
The documentation includes request examples, response examples and error code descriptions. Example data is generated from type definitions, so nothing needs to be maintained by hand. Change history is recorded by version to help callers assess upgrade impact.
- Supports mainstream TypeScript, Java, Python and Go frameworks
- Generates OpenAPI 3 specifications and HTML documentation
- Automatic sync on interface changes
- Version-to-version diff
How close is this template to your use case?
Most customers go live after changing 20–40% of a template. Book a workshop and we will assess it together.