Sawgger for APIs documentation
Use Cases and Deployment Scope
We use Swagger Open Source to produce an online API documentation. For now we don't use openApi to generate API. We use it do produce the documentation of our API for the BNA - Banque Nationale Alzheimer (Alzheimer National data bank).The produced documentation is a communication tool between us and the editors of patient records who send us data
Pros
- Produce documentation
- user interface to create api definition
- reusability of data description
Cons
- for me the UI can be more simple
- too many functionnalities when just want to produce doc, can be a separate app
- A french documentation will be apreciated
Return on Investment
- Less time to produce our documentation
- Documentation can be accessed online, this is a plus for our customers and partners
- Great tools to communicate with other project actors
Alternatives Considered
Postman and InterSystems IRIS
Other Software Used
InterSystems IRIS, InterSystems Caché, Postman