Node Blog API

Simple API written using NodeJS, Express and MongoDB.

Table of Content

Introduction
How to Setup Locally
API Endpoints

Introduction

This is a blog API built with Node JS and ExpressJS. It uses MongoDB for storing database. As of now, this project doesn't have front-end codes yet. You have to build front-end by yourself with any of the available framework (or with JS, HTML & CSS), make API call to back-end to fetch blogposts/users and render them in from-end. It uses JSON to transfar data between client and server.

How to Setup Locally

Fork this Repository(if you want to keep it sync) and clone the fork git clone <URL>
Change directory to the project root cd DIRNAME
Install npm packages using using npm install
Start your development server node bin/www

API Endpoints

All API calls need auth, i.e. you need an access token to make a successful API call. To get an access token, you need to register yourself using email and password. You can use mongo shell to create a document under collection users or you can use /signup endpoint. By default, /signup end-point save a new user as not approved account and doesn't have admin access. You can easily set them to true through mongo shell. Note that, it /api endpoints won't work if this options are set to false. Below is a sample fetch request to create a new account.

fetch('/auth/signup', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        name: 'YOUR NAME HERE',
        displayName: 'NICK NAME [OPTIONAL]',
        Website: 'example.com [OPTIONAL]',
        email: 'YOU@EMAIL.COM',
        password: 'YOUR PASS'
    })
})
.then(res => res.json())
.then(res => {
    // Here you will get your account status
})
.catch(err => console.log(err));

NOTE: ALL API REQUEST WANT YOU TO PASS AN ACCESS TOKEN GENERATED BY /auth/login TO MAKE A SUCCESSFUL API CALL. YOU CAN INCLUDE A TOKEN IN HEADER UNDER THE NAME x-access-token. BELOW IS AN EXAPMLE

...

fetch('/api/blog/posts'{
    method: 'GET',
    headers: {
        'Content-Type': 'application/json',
        'x-access-token': 'TOKEN HERE'
    }
})

...

BlogPost EndPoints

01 GET /api/blog/posts
02 GET /api/blog/find/:id
03 POST /api/blog/new
04 PUT /api/blog/update/:id

01 Retrieve all blog posts

/api/blog/posts

This end-point returns all posts store in your database. You can filter the results with a URL query. For example, if you want to find all the posts which aren't saved as a draft, use the the following URL string /api/blog/posts?draft=false. You can specify as many conditions you want to be satisfied. For example, /api/blog/posts?draft=true

02 Retrieve a Single Post by Post ID

/api/blog/find/:id

Get a post by it's unique ID (_id).

03 Insert a New Blog-Post

/api/blog/new

Insert a new blog post to database. You have to provide all the required fields.

04 Update an Existing Post

/api/blog/update/:id

You can update an existing blog post. All you need is the unique id(_id) of that post.

User EndPoints

01 GET /api/user/all
02 GET /api/user/find/:id
03 POST /api/user/register
04 PUT /api/user/update/:id
05 DELETE /api/user/delete/:id

abdus/node-blog-api

ErrorLooks like something went wrong!

About

Topics

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Languages

Error
Looks like something went wrong!

Packages