Sawgger for APIs documentation
Rating: 10 out of 10
IncentivizedUse 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
Likelihood to Recommend
To my opinion Swagger Open Source is a very good tool to quickly produce an api documentation, that how I use it.Swagger can also produce an open api file to generate an api for our application server (Inersystems Iris) but we don't use this functionality for now. We plan to use more Swagger features in the future.