Home

VPatientAPI Documentation

Welcome to the VPatientAPI documentation. This documentation is intended for developers who want to use the VPatientAPI to build applications that interact with the VPatientAPI. VPatient currently uses Express.js, MongoDB, GitHub Self-Hosted Runners and a VDS to run the API.

Getting Started

First you are going to need a server to host the API. If you don't intend to host the API in a server than you can also develop API in your local environment. But if you want to host the API in a server, you can use any server that supports Node.js and MongoDB. We recommend using a VDS or a VPS. You can also use a PaaS like Heroku or Glitch. Also you are going to need to set up SSL for your server. You can use a free SSL provider like Cloudflare or Let's Encrypt. We will be using CertBot to set up SSL for our server. But in order to use CertBot a valid hosting address is required. Such as 'api.vpatient.com'. Keep that in mind.

Setting things up

1- Setting up the API

2- Setting up the MongoDB

3- Setting up the GitHub Self-Hosted Runner

4- Setting up CertBot

How to use the API

Postman collection

How to develop the API

Project Structure