3 ms·
I don't see how Swagger helps me build, document or test my API. Anyone have a good experience to share?
by tschellenbach 9y ago
I don't see how Swagger helps me build, document or test my API. Anyone have a good experience to share?
- zamalek 9y agoSo far as documentation goes, OpenAPI does include fields for human consumption - such as "example". I've been using Swaggerhub to validate my OpenAPI documents and it clearly demonstrates what the automatically-generated documentation might look like. It won't help you at all with unit testing (you shouldn't be using HTTP for that). You can theoretically use it to generate a client library in your language of choice for integration tests (true for Swagger, not yet for OpenAPI). Finally, there are tools built around it that let you play around with APIs that have these specs - Microsoft PowerBI comes to mind. There are ways you could use it to build an API, but I wouldn't consider them a good idea. Edit: You could completely automate the process of ensuring that your semantic versions are compliant (i.e. you aren't breaking compatibility when you are claiming that you are not).