Hi, Glad you're here π.
This repo hosts a revamped version of The Movie Database (TMDB) API documentation. The documentation is built with Mintlify. Check it out here.
The migration from the official ReadMe-based documentation to Mintlify required a number of processes. They include the following:
- Testing the endpoints with Postman:
Each endpoint were thoroughly tested on postman to see what works and understand the API parameters.
- Converting the Postman collection to Open API spec (OAS):
The Postman collection containing all the APIs endpoints were exported as an openapi.json. This file was further converted ino a openapi.yaml file.
- Setting up a Mintlify documentation:
A mintlify documentation was setup to document the API reference and other important concepts of the TMDB API.
- Importing the OAS file to Mintlify:
The openapi.yaml file created in step 3 was imported to the Mintlify docs and was added automatically.
- The new documentation clearly describes the available authentication methods, including when and how to use them
- Improved information architecture that allows developers find what they need to use the API.
- Improved UI/UX to improve developer experience while using the docs
Add yours π€©....