README.md

API Reference

This directory provides detailed documentation of each endpoint in the NavigoLearn API.

Overview

For each endpoint, we provide the following details:

• The HTTP method (GET, POST, PUT, DELETE)
• Endpoint URL
• Required parameters in the request
• A short description of what the endpoint does
• An example request
• An example response

Endpoints

• /api
  • /api/auth
    • GET /api/auth/google-login
    • GET /api/auth/google-callback
    • GET /api/auth/github-login
    • GET /api/auth/github-callback
    • POST /api/auth/login
    • POST /api/auth/register
    • POST /api/auth/change-password
    • POST /api/auth/forgot-password (Not Implemented - Not planned)
    • DELETE /api/auth/logout
  • /api/search (formerly /api/explore)
    • GET /api/search/roadmaps
    • GET /api/search/feeling-lucky
    • ... More to be added
  • /api/roadmaps
    • GET /api/roadmaps/:roadmapId
    • POST /api/roadmaps/create
    • /api/roadmaps/:roadmapId
      • Update roadmap data
      • POST /api/roadmaps/:roadmapId/
      • POST /api/roadmaps/:roadmapId/about
      • POST /api/roadmaps/:roadmapId/name
      • POST /api/roadmaps/:roadmapId/description
      • POST /api/roadmaps/:roadmapId/topics
      • POST /api/roadmaps/:roadmapId/draft
      • POST /api/roadmaps/:roadmapId/version
      • POST /api/roadmaps/:roadmapId/data
      • POST /api/roadmaps/:roadmapId/misc-data
      • Interact with the roadmap
      • GET /api/roadmaps/:roadmapId/like
      • GET /api/roadmaps/:roadmapId/dislike
      • GET /api/roadmaps/:roadmapId/progress
      • POST /api/roadmaps/:roadmapId/progress
      • DELETE /api/roadmaps/:roadmapId/{like,dislike}
    • DELETE /api/roadmaps/:roadmapId
  • /api/users
    • GET /api/users/:userId?
    • GET /api/users/:userId/mini
    • GET /api/users/:userId/roadmaps
    • GET /api/users/:userId/follow
    • DELETE /api/users/:userId/follow
    • POST /api/users/
    • POST /api/users/name
    • POST /api/users/profile-picture (Not Implemented - Not plan)
    • POST /api/users/bio
    • POST /api/users/quote
    • POST /api/users/website-url
    • POST /api/users/github-url (To be added)
    • DELETE /api/users/:userId

Responses

All responses are in JSON format and have the keys success and message. The success key is a boolean that indicates whether the request was successful or not. The message key is a string that contains a message about the request. If the request was successful, the message key will contain a confirmation message. If the request was unsuccessful, the message key will contain an error message.

Additionally, some responses will contain a data key. The data key will contain the data requested by the user. For example, if the user requests a roadmap, the data key will contain the roadmap data.

Also, some responses will contain a total key. The total key will contain the total number of items that match the response data array. For example, if the user requests a list of roadmaps, the total key will contain the total number of roadmaps that match the request.

Each response file above contains an example response.

Note

Please note that this API reference is a work in progress and will continue to grow as new endpoints are added to the NavigoLearn API.

And some might change requirements or functionality as the project evolves.