API Guide Sample
Context: When I had the opportunity to learn more about automated documentation generation for APIs, I chose to try out Stoplight.io.
Process: I put together this example with the help of some videos, tutorials, and the OpenWeather APIs. There are full descriptions for the API itself, as well as a weather endpoint, which are accessible by clicking on the labels on the left-hand side of the screen under APIs. Along with full descriptions of each parameter and message, the documentation includes sample responses and a tool that allows developers to try out the code for themselves.
Tools: OpenAPI (aka Swagger), Stoplight.io, YAML, REST, JSON
