REST API for a simple blog

Welcome to this REST API! This is a great tool to create your own blog or similar website. In this README, you'll find all the information you need to use this API, including how to configure it and install it. It's easy to use and set up, so get started

Read this in other lenguages: English,Español.

Installation

Clone the Repository

Begin by cloning the repo to a local directory. Usually the content is installed in a folder called api where you will find the source code for the API.

Install Dependencies

You'll need to install the project dependencies in order to have the API up and running. To do this, use either npm or yarn to install them:

npm install or yarn install works.

Setting up the .env file and database

As this API is working with PostgreSQL, you will need to setup a PG database.

You'll need to setup a .env file at root directory with a structure like this one:

DB_NAME = <YOUR PG DATABASE NAME>
USER = <YOUR USER OF PG OR "postgres">
PASSWORD = <YOUR PG PASSWORD OR "">
HOST = <PRODUCTION HOST OR "localhost">
PORT = <YOUR BACKEND PORT>

JWT_ACCESS_TOKEN = <YOUR ENCRYPTED TOKEN>

ADMIN_NAME = <ADMIN_NAME>
ADMIN_USERNAME = <USERNAME>
ADMIN_PASSWORD = <PASSWORD>
ADMIN_EMAIL = <EMAIL>

Tip: If you doesn't know how to setup a JWT_ACCESS_TOKEN, you can just write this code at your terminal console to generate one:

node
require('crypto').randomBytes(64).toString('hex')

The admin section is just the setup of the user that will have extra permissions in the system

Issues

Issues are a great way to keep track of tasks, bug fixes, and feature requests in the project.

For any bug, fix, or feature, open a issue following the template.

Make sure to follow the steps at ISSUE_TEMPLATE.md to be approved.

Contributions

❤️ contributions!

I am open to any discussion on further development.

I am open to accepting your pull request if it meets the following criteria:

Includes tests
Appears reasonable
Does not break backwards compatibility

If your proposed change could potentially break backwards compatibility, please mention it in your pull request. From there, we can discuss how we can release it and what kind of documentation or communication will be necessary.

See CONTRIBUTING.md for ways to get started.

Authentication

You will need to setup JWT_ACCESS_TOKEN at .env to get the Authentication work correctly.

Before we get into the API Reference we need ot understand how the authentication works. To query every endpoint you will need an authenticated token to get access, so the first step of the authentication is to create an account and then login (These are the unique endpoints that doesn't need any authentication).

Or you can just use the admin user to login, it also has special permissions to use the admin routes.

At API Reference you will find that authentication will appear in some colors.

- Red is for not required authentication
+ Green is for required authentication

Create user

  POST /users

Body params

Parameter	Type	Description
`name`	`string`	Required. A valid name with length of 3-25
`username`	`string`	Required. A valid username with length of 3-25
`email`	`string`	Required. A valid email string
`password`	`string`	Required. At least have a number and a letter 5-30

Once you have created the user, and you get an success message you need to login to obtain the accessToken.

Login

  POST /auth/login

Body params

Parameter	Type	Description
`username`	`string`	Required. A valid existing username
`password`	`string`	Required. The password of the existing username

You will get a response like this:

{
	"accessToken": "eyJhbGciOiJIxxxxxxxxxxxxxxxxxn31v3co1A",
	"message": "User authenticated."
}

The length of the accessToken depends directly on the length of your JWT_ACCESS_TOKEN.

Once you have your accessToken, you may need to authorize every request you made from henceforth. You will need to add an authorization header into your requests:

Using fetch:

fetch('https://example.com/api/endpoint', {
	method: 'GET', // POST PUT DELETE
	headers: {
		Authorization: `Bearer ${accessToken}`,
	},
}).then(...);

Using axios:

axios.get('https://example.com/api/endpoint', {
	//.post .put .delete request
	headers: {
		Authorization: `Bearer ${accessToken}`,
	},
}).then(...);

API Reference

You will need to read the Authentication section first to make sure that every query is authenticated to work properly.

Here a table of every endpoint so you can access quickly:

Error handling
Auth endpoint
- POST Login
Users endpoint
Posts endpoint
Favorites endpoint
- POST Favorites
- DELETE Favorites
Reactions endpoint
Comments endpoint
Upvotes endpoint
- POST Upvote
- DELETE Upvote
⭐ Admin endpoints
- Admin Posts
  - PUT Admin Post
  - DELETE Admin Post
- Admin Users
  - PUT Admin User
  - DELETE Admin User
Extra Utils
- Users search
- Posts pagination

Error handling

Every error that occurs whem you are trying to request something, you will get a response like this:

{
	"error": true,
	"message": "..."
}

Where "message" explains the error and most cases explains how to solve it.

Auth endpoint

POST Login

- Authentication is not required

This is the main method to login, which is used to get the accessToken. You can check the Authentication process here

  POST /auth/login

Body params

Parameter	Type	Description
`username`	`string`	Required. A valid existing username
`password`	`string`	Required. The password of the existing username

200 Response

{
	"accessToken": "eyJhbGciOiJIxxxxxxxxxxxxxxxxxn31v3co1A",
	"message": "User authenticated."
}

Users endpoint

POST Users

- Authentication is not required

  POST /users

Body params

Parameter	Type	Description
`name`	`string`	Required. A valid name with length of 3-25
`username`	`string`	Required. A valid username with length of 3-25
`email`	`string`	Required. A valid email string
`password`	`string`	Required. At least have a number and a letter 5-30

200 Response

{
	"id": "b943a71f-xxxx-xxxx-xxxx-d88c80d9bcd3",
	"admin": false,
	"status": true,
	"username": "usernameofsomeone22",
	"email": "[email protected]",
	"password": "$2b$10$0m7Of4KQqDbseapROuUBn.rpqr73E58Zrv0mmUW8zigqw60fygD/m",
	"name": "Someones name",
	"updatedAt": "yyyy-mm-dd",
	"createdAt": "yyyy-mm-dd"
}

GET Users

+ Authentication is required

  GET /users

Query params

Parameter	Type	Description
`name`	`string`	Optional. Search parameter
`username`	`string`	Optional. Search parameter
`email`	`string`	Optional. Search parameter

You can see more information about the user search parameters and the uses here

200 Response

{
	"info": {
		"count": 100 // Or the count of results found
	},
	"results": [
		{
			"id": "798dfe94-7f7a-4571-a1ea-7805dc973c4d",
			"name": "example",
			"email": "[email protected]",
			"username": "someone02",
			"posts": [],
			"favorites": [],
			"reactions": []
		},
		{
			//... someone else
		}
	]
}

GET one User

+ Authentication is required

  GET /users/${id}

Params

Parameter	Type	Description
`id`	`string`	Required. UUID used to find someone

200 Response

{
	"user": {
		"id": "798dfe94-7f7a-4571-a1ea-7805dc973c4d",
		"name": "example",
		"email": "[email protected]",
		"username": "someone02",
		"posts": [],
		"favorites": [],
		"reactions": []
	},
	"message": "User created successfully!"
}

PUT User

+ Authentication is required (only self-updating is allowed)

  PUT /users/${id}

Params

Parameter	Type	Description
`id`	`string`	Required. UUID used to find someone

Body params

Parameter	Type	Description
`name`	`string`	Optional. A valid name with length of 3-25
`username`	`string`	Optional. A valid username with length of 3-25
`email`	`string`	Optional. A valid email string

200 Response

{
	"message": "User updated successfully!"
}

DELETE User

+ Authentication is required (only self-deleting is allowed)

  DELETE /users/${id}

Params

Parameter	Type	Description
`id`	`string`	Required. UUID used to find someone

200 Response

{
	"message": "User deleted successfully!"
}

Posts endpoint

POST Posts

+ Authentication is required

  POST /posts

Body params

Parameter	Type	Description
`title`	`string`	Required. A valid title with length of 1-50
`content`	`string`	Required. A valid content (html accepted) with length of 10-5000
`tags`	`array[stings]`	Optional. String tags

200 Response

{
	"post": {
		"disabled": false,
		"id": 1,
		"title": "This is a good title!",
		"tags": ["irrelevant", "ignore"],
		"content": "This is an extreme irrelevant post, just ignore it'",
		"userId": "13ad2972-9679-4d5a-b1d7-f388d60a9e63", // ID of the user that created the post
		"updatedAt": "yyyy-mm-dd",
		"createdAt": "yyyy-mm-dd"
	},
	"message": "Post created successfully!"
}

GET Posts

+ Authentication is required

  GET /posts

Query params

Parameter	Type	Description
`page`	`string`	Optional. Pagination parameter
`limit`	`string`	Optional. Pagination parameter

You can see more information about the pagination parameters and the uses here

200 Response

{
	"info": {
		//Pagination
		"count": 2,
		"pages": 1,
		"nextPage": null,
		"prevPage": null
	},
	"results": [
		//Results
		{
			"id": 1,
			"title": "This is a good title!",
			"tags": ["irrelevant", "ignore"],
			"content": "This is an extreme irrelevant post, just ignore it'",
			"disabled": false,
			"userId": "bbea059c-652d-4a85-9110-33ff5a3010d5",
			"createdAt": "2023-01-11T00:34:24.752Z",
			"updatedAt": "2023-01-11T00:34:24.760Z",
			"favorites": [],
			"comments": [],
			"reactions": []
		},
		{
			"id": 2,
			"title": "Just another post",
			"tags": [],
			"content": "This is other post",
			"disabled": false,
			"userId": "bbea059c-652d-4a85-9110-33ff5a3010d5",
			"createdAt": "2023-01-11T00:34:28.988Z",
			"updatedAt": "2023-01-11T00:34:28.993Z",
			"favorites": [],
			"comments": [],
			"reactions": []
		}
	]
}

GET one Post

+ Authentication is required

  GET /posts/${id}

Params

Parameter	Type	Description
`id`	`uint`	Required. uint used to find the post

200 Response

{
	"id": 2,
	"title": "Just another post",
	"tags": [],
	"content": "This is other post",
	"disabled": false,
	"userId": "b2cb15bc-2d47-461e-9c87-9e024f899aa1",
	"createdAt": "2023-01-11T01:01:02.038Z",
	"updatedAt": "2023-01-11T01:01:02.044Z",
	"favorites": [],
	"comments": [],
	"reactions": []
}

PUT Post

+ Authentication is required (Owner of the post must update)

  PUT /posts/${id}

Params

Parameter	Type	Description
`id`	`uint`	Required. uint used to find the post

Body params

Parameter	Type	Description
`title`	`string`	Optional. A valid title with length of 1-50
`content`	`string`	Optional. A valid content (html accepted) with length of 10-5000
`tags`	`array[stings]`	Optional. String tags

200 Response

{
	"message": "Post updated successfully!"
}

DELETE Post

+ Authentication is required (Owner of the post must delete)

  DELETE /posts/${id}

Params

Parameter	Type	Description
`id`	`uint`	Required. uint used to find the post

200 Response

{
	"message": "Post deleted successfully!"
}

Favorites endpoint

POST Favorites

+ Authentication is required

  POST /favorites

Body params

Parameter	Type	Description
`postId`	`uint`	Required. uint used to find the post

200 Response

{
	"message": "Added post to favorites"
}

DELETE Favorites

+ Authentication is required

  DELETE /favorites

Body params

Parameter	Type	Description
`postId`	`uint`	Required. uint used to find the post

200 Response

{
	"message": "Removed post from favorites"
}

Reactions endpoint

POST Reactions

+ Authentication is required

  POST /reactions

Body params

Parameter	Type	Description
`postId`	`uint`	Required. uint used to find the post
`type`	`string`	Required. "love","sad","like"

200 Response

{
	"message": "Added post to Reactions"
}

PUT Reactions

+ Authentication is required

  PUT /reactions

Body params

Parameter	Type	Description
`postId`	`uint`	Required. uint used to find the post
`type`	`string`	Required. "love","sad","like"

{
	"message": "Updated reaction"
}

DELETE Reactions

+ Authentication is required

  DELETE /reactions

Body params

Parameter	Type	Description
`postId`	`uint`	Required. uint used to find the post

200 Response

{
	"message": "Removed post from Reactions"
}

Comments endpoint

POST Comment

+ Authentication is required

  POST /comments

Body params

Parameter	Type	Description
`postId`	`uint`	Required. uint used to find the post
`content`	`string`	Required. The content of the comment

200 Response

{
	"message": "Added Comment"
}

PUT Comment

+ Authentication is required

  PUT /comments

Body params

Parameter	Type	Description
`postId`	`uint`	Required. uint used to find the post
`content`	`string`	Required. The content of the comment

{
	"message": "Updated Comment"
}

DELETE Comment

+ Authentication is required

  DELETE /comments

Body params

Parameter	Type	Description
`postId`	`uint`	Required. uint used to find the post

200 Response

{
	"message": "Removed Comment"
}

Upvotes endpoint

POST Upvote

+ Authentication is required

  POST /upvotes

Body params

Parameter	Type	Description
`commentId`	`uint`	Required. uint used to find the comment

200 Response

{
	"message": "Added upvote"
}

DELETE Upvote

+ Authentication is required

  DELETE /upvotes

Body params

Parameter	Type	Description
`commentId`	`uint`	Required. uint used to find the comment

200 Response

{
	"message": "Removed upvote"
}

Admin endpoints

Admin Posts

PUT Admin Post

+ Authentication is required (must be admin)

  PUT /admin/posts/${id}

Body params

Parameter	Type	Description
`title`	`string`	Optional. A valid title with length of 1-50
`content`	`string`	Optional. A valid content (html accepted) with length of 10-5000
`tags`	`array[stings]`	Optional. String tags
`disabled`	`boolean`	Optional. true / false

Params

Parameter	Type	Description
`id`	`uint`	Required. uint used to find the post

200 Response

{
	"message": "Post updated successfully!"
}

DELETE Admin Post

+ Authentication is required (must be admin)

  DELETE /admin/posts/${id}

Params

Parameter	Type	Description
`id`	`uint`	Required. uint used to find the post

200 Response

{
	"message": "Deleted post successfully!"
}

Admin Users

PUT Admin User

+ Authentication is required (must be admin)

  PUT /admin/users/${id}

Params

Parameter	Type	Description
`id`	`string`	Required. UUID used to find someone

Body params

Parameter	Type	Description
`name`	`string`	Optional. A valid name with length of 3-25
`username`	`string`	Optional. A valid username with length of 3-25
`email`	`string`	Optional. A valid email string
`admin`	`boolean`	Optional. true / false
`status`	`boolean`	Optional. true / false

200 Response

{
	"message": "User updated successfully!"
}

DELETE Admin User

+ Authentication is required (must be admin)

  DELETE /admin/users/${id}

Params

Parameter	Type	Description
`id`	`string`	Required. UUID used to find someone

200 Response

{
	"message": "User deleted successfully!"
}

Extra Utils

Users Search

To find any user you can find it using the GET /users request with the query parameters name, username and email.

Here is an example on how you can use it:

GET /users?username=ro

200 Response

{
	"info": {
		"count": 2
	},
	"results": [
		{
			"id": "441d6e20-dfc5-47a4-8d4c-d9be73cba0f1",
			"name": "Dorothea Tanner",
			"email": "[email protected]",
			"username": "dorothea90",
			"posts": [],
			"favorites": [],
			"reactions": []
		},
		{
			"id": "dea31d42-a760-49cc-a422-eeef90eee970",
			"name": "Gross Ruiz",
			"email": "[email protected]",
			"username": "gross92",
			"posts": [],
			"favorites": [],
			"reactions": []
		}
	]
}

You can also concat the query parameters:

GET /users?username=ro&email=dorothea

200 Response

{
	"info": {
		"count": 1
	},
	"results": [
		{
			"id": "441d6e20-dfc5-47a4-8d4c-d9be73cba0f1",
			"name": "Dorothea Tanner",
			"email": "[email protected]",
			"username": "dorothea90",
			"posts": [],
			"favorites": [],
			"reactions": []
		}
	]
}

Posts Pagination

You will see that the posts are paginated. You can use the pagination to get the posts separately in different pages. There is two params you can use to control the pagination, the first one is the page,which determins in what page are you and the second is limit that determines how many posts are returned per page.

Query Params

Parameter	Type	Description	Default value
`limit`	`uint`	Optional. This is the value of posts returned each page,max value of 50	10
`page`	`uint`	Optional. This value determines in which page are you based on the limit	1

Once you use that querys (or not) you will get a info response like this:

"info": { // Example using default values
    "count": 44,
    "pages": 5,
    "nextPage": 2,
    "prevPage": null
  },

The info response calculates the total number of pages based on the limit specified, you can see also that it has the nextPage and prevPage properties that are null when there is no page and has a number of the next/prev page when has content.

The results property gives you limit results per page.

License

This project is using MIT License.

Authors

@Nikire

Name		Name	Last commit message	Last commit date
Latest commit History 56 Commits
.github		.github
src		src
.gitignore		.gitignore
index.js		index.js
package.json		package.json

Nikire/PERN-api-blog

Folders and files

Latest commit

History

Repository files navigation

REST API for a simple blog

Table of Contents

Installation

Issues

Contributions

Authentication

Create user

Login

API Reference

Error handling

Auth endpoint

POST Login

Users endpoint

POST Users

GET Users

GET one User

PUT User

DELETE User

Posts endpoint

POST Posts

GET Posts

GET one Post

PUT Post

DELETE Post

Favorites endpoint

POST Favorites

DELETE Favorites

Reactions endpoint

POST Reactions

PUT Reactions

DELETE Reactions

Comments endpoint

POST Comment

PUT Comment

DELETE Comment

Upvotes endpoint

POST Upvote

DELETE Upvote

Admin endpoints

Admin Posts

PUT Admin Post

DELETE Admin Post

Admin Users

PUT Admin User

DELETE Admin User

Extra Utils

Users Search

Posts Pagination

License

Authors

About

Topics

Resources

Code of conduct

Stars

Watchers

Forks

Releases 1

Packages 0

Languages

Packages