Company
Date Published
Author
Dom Harrington
Word count
316
Language
English
Hacker News points
None

Summary

The announcement highlights the completion of a highly requested feature: the new API Explorer, which now supports the OpenAPI 3.0 (OAS 3.0) Specification alongside the existing Swagger 2.0 files. Initially, ReadMe only accepted Swagger 2.0 files, but with the release of OAS 3.0, the team utilized the swagger2openapi package to convert specifications and the swagger-parser package to parse, validate, and resolve these files, simplifying the integration process. The new API Explorer is automatically enabled for projects created after July 6, 2018, while older projects can soon opt-in through settings. Users are encouraged to test the new API Explorer with their current Reference documentation using a specific query parameter and report any issues. New API endpoints have been established for handling OAS 3 files, and while the rdme CLI program lacks a dedicated OAS command, it can process OAS files using the existing swagger command. Special thanks are extended to contributors for their support in developing these features.