OpenAPI has become the current standard for API definitions and documentation. It is very important from the consumers and developers perspective to have up-to-date and accurate documentation on all API resources.
Ideally, a business and its developers will be following an API-First approach to developing an API ecosystem. This is where there is an assumption that the API will be consumed by other server applications, micro-services, mobile apps and single page websites. Therefore, the API becomes a first-class citizen in the development process and is designed and created before any development is done on the applications or websites.
However, this is not always practical, due to existing legacy code or not enough time to follow due processes. This can potentially lead to a fragmented and inconsistent API, with nonexistent or bad documentation.
ApiOpenStudio has been designed to be agnostic and un-opinionated about both approaches, can accommodate both workflows and make things as easy and streamlined as possible. ApiOpenStudio allows you to:
ApiOpenStudio internally groups the resource documentation by application. This means that you can serve the documentation to clients as a whole.
Whenever an application is created, an OpenAPI document is generated internally.
Whenever you create any resources assigned to that application will be automatically added to the document.
You can then edit the base documentation as you see fit using the core API or the Admin GUI