📰 Blog API

Simple API for building cool blogs
Crafted using Nest.js + MongoDB

🔍 Overview

This API provides the ability to create simple blogs with markdown markup based on an already created system of posts and comments. For convenient blogging, there is an administrator authorization service with a set of secure routes. The comments service does not require registration, but all comments can be verified by administrators.

🚀 Launch server

1. Clone this repository
2. Create .env file with connection URI and JWT secret key

DATABASE_URI=mongodb://mongodb0.example.com:27017
JWT_SECRET=PasteYourJwtSecret

3. Install all packages

npm install

4. Run server for development/production

npm run start:dev

npm run start

🐳 Launch using Docker

1. Build docker image

docker build . -t blog-api

2. Launch containter

docker run -p 3000:3000 --env-file .env --name server blog-api

📄 API usage

You can use a specially prepared collection of endpoints for Insomnia client. For this just import ./blog-api.insomnia.json file.

🔐 Auth for admins

Method	URI	Body (JSON)	Action
POST	/api/auth/register	{   "email": "example@mail.com",   "password": "example" }	Registration for admins
POST	/api/auth/login	{   "email": "example@mail.com",   "password": "example" }	Login for admins

📮 Post service

Method	URI	Body (JSON)	Action
POST	/api/post	{   "category": "category",   "title": "title",   "image": "test.png",   "tags": ["one", "two"],   "content": "Hello World!" }	Create post (For admins)
GET	/api/post/id	none	Find post by id
GET	/api/post/withComments/id	none	Find post by id with comments
POST	/api/post/find/id	{   "category": "category",   "limit": 100 }	Find posts by category
PATCH	/api/post/id	{   "category": "category",   "title": "title",   "image": "test.png",   "tags": ["one", "two"],   "content": "Hello World!" }	Update post by id (For admins)
DELETE	/api/post/id	none	Delete post by id (For admins)

🎤 Comment service

Method	URI	Body (JSON)	Action
POST	/api/comment	{   "author": "Author",   "email": "test@mail.com",   "content": "Hello World!",   "postId": id }	Create comment for post
GET	/api/comment/id	none	Find comment by id
GET	/api/comment/byPost/id	none	Find comment by post id
GET	/api/comment/verified/id	none	Verified comment by id (For admins)
DELETE	/api/comment/id	none	Delete comment by id (For admins)