November 2021 Summaries

Recent updates have enhanced the developer experience during both the API design phase and user interaction with the API documentation. Notably, developers can now live preview documentation while writing their API definition files, allowing for real-time updates without the need for specific text editors or extensions, simply by using the bump CLI with the --live flag. Additionally, a new diff navigation feature enables users to swiftly identify and navigate through changes in the API documentation, improving efficiency by eliminating excessive scrolling. Furthermore, the support for multiple examples in the documentation caters to diverse use cases, offering API users a more tailored and comprehensive understanding, as these examples are compatible with OpenAPI and AsyncAPI specifications.

Last month introduced several enhancements aimed at improving the developer experience during the API design process and enhancing user comprehension of APIs. These improvements include a live preview feature for documentation, allowing developers to see real-time updates while editing API definition files, without needing a specific text editor or extension, by using the Bump CLI with a simple --live flag. Additionally, the diff navigation feature streamlines the process of identifying changes in the API documentation, enabling users to easily jump between changes without excessive scrolling. Furthermore, the support for multiple examples in API documentation caters to diverse use cases, offering users a more personalized and comprehensive understanding of the API, with both OpenAPI and AsyncAPI specifications being supported.