A GraphQL based feature rich blogging API.
See full documentation HERE for API docs, configuration and deployment options.
Features
Lightweight
Median API is very lightweight as compared to other REST based API. And the main reason is that you get only the content you request for, which is not possible (or atleast cumbersome) in REST architecture.
For example if you only want titles of top 3 blogs, you can just pass a query like this and in response you only get those 5 respective titles:
Platform Agnostic
The API is fully platform agnostic, ie any client on any platform can use this API. These include React application, Angular, Electron, Flutter, Native desktop apps on Qt etc. The possibilities are endless.
Even if your platform doesnt have a library to make graphQL based request, you can use Median. See: (a blog reg this)
Open Source
The API is fully open source, you can freely host it on your own server with all the customizations you want.
Local Setup
- Clone this repo:
git clone https://github.com/deprov447/median-server - Run
npm install - Setup environment variables :
- Create a
.envfile in root directory of the project - Insert these 3 keys/value pairs :
- PORT : < Port on which server will listen >
- DB_ADDR : < Mongo database connection URI >
- SECRET : < Secret key for signing auth tokens >
- Create a
- Start the server:
npm start - Start requesting from a client (eg: playground)
Or the same can be done using docker also:
docker pull deprov447/median-api
Buy me a coffee
Whether you use this project, have learned something from it, or just like it, please consider supporting it by buying me a coffee, so I can dedicate more time on open-source projects like this :)
License
This project is licensed under the terms of the MIT license.