Company
Date Published
Author
Angel Guarisma
Word count
668
Language
English
Hacker News points
None

Summary

Kong introduces a new approach to API documentation by using a single source of truth in their schemas, which powers both their code and documentation to ensure accuracy and timeliness. They have launched beta OpenAPI specifications for the Kong Gateway Admin API and Konnect Runtime Groups configuration API, which integrate seamlessly with existing toolchains, facilitating SDK generation and interaction through platforms like Kong Insomnia. This approach allows users to compare different API versions, validate endpoint functionality through automated tests, and maintain up-to-date documentation. Although Kong Gateway, an open-source project, initially used Lua schemas as its source of truth, the shift to generating JSON schema entities directly from the code ensures alignment with code changes. Despite the ongoing refinement of the generation process, Kong aims to transition to a design-first methodology where OpenAPI serves as the primary source of truth, while inviting feedback to enhance the specifications further.