Not sure where you heard that phrase.
Swagger is a set of tools around the OpenAPI Specification. The latter allows API documentation. However, there’s no magic. The specification lets you describe all the things you mentioned – if those are not provided by whoever is documenting the API, that’s on them. From: <swagger-swaggersocket@googlegroups.com> on behalf of destino <rucont...@gmail.com> Reply-To: "swagger-swaggersocket@googlegroups.com" <swagger-swaggersocket@googlegroups.com> Date: Tuesday, November 28, 2017 at 13:28 To: Swagger <swagger-swaggersocket@googlegroups.com> Subject: "Just use swagger its self documenting" I am a tester who has heard the commentary among devs that API is self documenting. And they leave it at that, as though "no need to discuss anymore" where i feel like the truth is actually that there is a dependency on the front end that the devs actually have to include documentary. i.e. Implementation Notes could include much more documentation (words) instead of the two word reminder to the dev. Notes about required fields or syntax in the fields that are passed in. (often i may be testing an endpoint only to find out syntax needs to be "X" or certain fields are required. Point being "to say swagger is self documenting" is a little misleading and needs a qualifier. *provided the documentation is included in code. Am i right or wrong? or somewhere in between. thank you (first time here) -- You received this message because you are subscribed to the Google Groups "Swagger" group. To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsubscr...@googlegroups.com. For more options, visit https://groups.google.com/d/optout. -- You received this message because you are subscribed to the Google Groups "Swagger" group. To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsubscr...@googlegroups.com. For more options, visit https://groups.google.com/d/optout.
