Redoc

Mahmoud-Tudor Hamdan

Frontend Engineer
Cypress
React
Bigtech

OpenAPI/Swagger-generated API Reference Documentation

Original project

Redoc is an open source tool for generating documentation from OpenAPI (formerly Swagger) definitions.
By default Redoc offers a three-panel, responsive layout:
The left panel contains a search bar and navigation menu.
The central panel contains the documentation.
The right panel contains request and response examples.

My open source fork contribution

Extended the generator to meet client business requirements, adding a new panel to enable API testing based on dynamically generated forms, request content types and response stream types
Extended the project so that it'd support being used as a multi-instance standalone application instead of just one app, based on remotely fetched OpenAPI specs
Adapted the UI to match client's styling so that it fits together with the rest of the products

Outcome

Saved millions of dollars in revenue single-handedly by meeting clients' needs when it comes to generating Swagger-like documentation UIs dynamically while being able to interact with those APIs like we do in Postman, thereby avoiding the necessity for a Premium License purchase.
Partner With Mahmoud-Tudor
View Services

More Projects by Mahmoud-Tudor