Search results

Swagger UI Demo

Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 4,500+ subscribers

When you use Swagger UI, it's not necessary for the Swagger UI output to be a standalone site. You can also embed Swagger into an existing web page. The following is an embedded instance of the Swagger UI showing the OpenAPI file for the OpenWeatherMapAPI.

While the Swagger UI display is designed to be responsive, the collapse/expand sections in the Model views still have overflow issues in responsive views, so you might run into issues with embedding.

Personally, I prefer to separate out Swagger UI from the rest of my docs simply because I dislike the sense of a website within a website. Developers can keep the Swagger UI page open as a quick reference while they work on their projects. I view the Swagger UI reference output similar to the standalone nature of Javadoc.

68% Complete

68/108 pages complete. Only 40 more pages to go...

Donate?

Want to buy me lunch? Click the Donate button below to donate $10 through Paypal.

Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 4,500+ subscribers