Skip to content

TmdbAPI/TMDB

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

21 Commits
Β 
Β 

Repository files navigation

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.

Process πŸ§‘β€πŸ’»

The migration from the official ReadMe-based documentation to Mintlify required a number of processes. They include the following:

  1. Testing the endpoints with Postman:

Each endpoint were thoroughly tested on postman to see what works and understand the API parameters.

  1. 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.

  1. Setting up a Mintlify documentation:

A mintlify documentation was setup to document the API reference and other important concepts of the TMDB API.

  1. Importing the OAS file to Mintlify:

The openapi.yaml file created in step 3 was imported to the Mintlify docs and was added automatically.

So, what's changed?

  1. The new documentation clearly describes the available authentication methods, including when and how to use them
  2. Improved information architecture that allows developers find what they need to use the API.
  3. Improved UI/UX to improve developer experience while using the docs

Add yours 🀩....

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published