Latest

Redoc - Instant API documentation

11:53 PM , Views

 Introduction:

In this article, we will explore the best API documentation tool.

THE BEST FREE API DOCUMENTATION TOOL 

There are plenty of tools available for doing API documentation  - some are open-source.

Today, I have found an advanced ease solution called Redoc - Easily deployable API documentation.  😇

Redoc Community Edition is a free open-source software.

https://redoc.ly/redoc

Redoc is an open-source tool that generates API documentation from OpenAPI specifications. It’s one of the most powerful free docs tools in the industry, producing clean, customizable documentation with an attractive three-panel design. With support for Markdown, it allows you to write and style descriptions with ease.

By default, Redoc uses a three-panel layout: 

  • The left panel features a search bar and navigation menu.
  • The central panel contains the documentation itself.
  • The Right panel contains request and response samples.

Github - https://github.com/Redocly/redoc

Installing Redoc in under 5 minutes.  

Create a basic html page with default tags and add redoc tag and add the JavaScript reference for redoc.standalone.js

Ex:

<!DOCTYPE html>

<HTML>

    <head>

           <title> API Documentation</title>

     </head>

     <body>

           <redoc spec-url=API-service-v1.0.0.json' lazy-rendering></redoc>             

           <script src="redoc.standalone.js"> </script>

      </body>

</html>

 
Redoc supports OpenAPI (OAS2 and OAS3)

Redoc supports advanced OpenAPI v3 declarations like nested objects, the discriminator, “one of”, “any of”, “all of”, or nullable, and callbacks that aren’t supported properly in competitor tools.

Swagger UI

Swagger UI is the best-known solution for generating API documentation. However, the design is outdated when compared with Redoc.




Conclusion:

Redoc is the best choice and it looks great for the open-source solution also it is easy to implement.


Hope this article helps !!


Thanks for reading this article ! ! please leave your comments and the suggestion about this article. 

No comments

Subscribe to: Post Comments ( Atom )