Blogs›IBM›OpenAPI Specification Generation from Code Comments
The OpenAPI Comment Parser is a new tool that allows developers to generate OpenAPI specifications directly from comments within their code. This aims to simplify API documentation, ensure it stays up-to-date with code changes, and reduce the amount of spec writing required. It supports Node.js and can work with any language using a similar comment style. The generated documentation can also be used for API testing.
8/5/2020
Introduces the OpenAPI Comment Parser, a Node.js library and CLI tool that generates OpenAPI specifications from inline code comments. It defines a new spec format that reduces writing effort by 50% on average and enables developers to keep documentation synchronized with code. The tool is available on GitHub.