A new & improved Swagger UI theme

swagger-ui-improved-theme

Welcome to Swagger UI Improved Theme, a project aimed at enhancing the visual appeal of Swagger UI documentation. If you've ever found Swagger UI to be a bit bland and in need of a facelift, you're in the right place. This theme strives to make Swagger UI documentation look cooler and more visually engaging. Be sure to check out the screenshots to see the theme in action!

Note

• The theme is designed to work seamlessly with OpenAPI v3 and above.
• It also provides support for Swagger v2, though it may not be fully tested. Most features should work fine, but keep in mind that future updates will focus primarily on v3 and above.
• In the event that a change in the OpenAPI specification breaks compatibility with Swagger v2, it will not be actively addressed in future updates.

How to use?

Using the Swagger UI Improved Theme is a breeze. You have two options:

1. Download Locally:

   • Simply download the CSS file from this repository and include it in your project.

2. Use a CDN - jsDelivr:

   • Copy and paste the following URL into your project:

    https://cdn.jsdelivr.net/gh/ajatkj/swagger-ui-improved-theme/css/swagger-ui-improved.css
   

• This allows you to seamlessly integrate the theme into your Swagger UI documentation without the need to host the file yourself.

Screenshots

Contributions

If you're passionate about improving Swagger UI documentation and have ideas for enhancements, feel free to contribute to this project. Open-source thrives on collaboration, and your input could make a significant impact.

Conclusion

Swagger UI Improved Theme aims to inject style and modern aesthetics into your API documentation. Whether you're working with OpenAPI v3 or Swagger v2, this theme provides an opportunity to showcase your API in a visually appealing way. Download it, give it a try, and let your Swagger UI documentation stand out from the crowd!