Ohpen :: Dev Portal and REST API Guidelines

In 2019, Ohpen started developing its own REST API. As the second technical writer to join the company, I set myself to the task of defining the documentation strategy for the API and the new Web Portal, advocating for OpenAPI 3.0 and API First design. In 2020, we launched our dev portal, which is still under active development.

At the same time, I also created an internal tool, the OpenAPI Viewer, using React and ReDoc, to load the Postman-hosted specifications for easy consumption. When I left, the OpenAPI Viewer was being used daily by tens of developers, QAs, and product owners.

How

Some of the things I’ve done so far:


Stack