(Swagger can be used for lots of other things, such as for generating client SDKs or unit testing.) Background termsįirst, some terms. Also, I’m just using the Swagger UI display as an interactive API console to complement my main documentation. Note that I’m manually creating the spec, not generating it from programming code.

In this post, I want to share a few realizations I had in configuring the Swagger spec and UI display. The API requests and responses are much more complex.

This past week I’ve been creating a real Swagger spec and UI output for one of the APIs I document at work. Using SwaggerĪlthough I created a Swagger tutorial for my REST API course, the Swagger spec I created was for a simple API that just had a few basic endpoints with several query parameters.

For more up-to-date info on Swagger, see the Swagger introduction and Swagger tutorial that I created in my API documentation course. Note: The new version of Swagger UI fixes many of the issues I noted here.

Academic/Practitioner Conversations Project.

Author in DITA and Publish with WordPress.

Reflecting seven years later about why we were laid off.

A hypothesis about influence on the web and the workplace.

How to use swagger editor and ui