Build a RESTful API for a personal blogging platform
You are required to create a simple RESTful API with basic CRUD operations for a personal blogging platform. CRUD stands for Create, Read, Update, and Delete.
The goals of this project are to help you:
Understand what the RESTful APIs are including best practices and conventions
Learn how to create a RESTful API
Learn about common HTTP methods like GET, POST, PUT, PATCH, DELETE
Learn about status codes and error handling in APIs
Learn how to perform CRUD operations using an API
Learn how to work with databases
You should create a RESTful API for a personal blogging platform. The API should allow users to perform the following operations:
Create a new blog post
Update an existing blog post
Delete an existing blog post
Get a single blog post
Get all blog posts
Filter blog posts by a search term
Given below are the details for each API operation.
Create a new blog post using the POST
method
Each blog post should have the following fields:
The endpoint should validate the request body and return a 201 Created
status code with the newly created blog post i.e.
or a 400 Bad Request
status code with error messages in case of validation errors.
Update an existing blog post using the PUT
method
The endpoint should validate the request body and return a 200 OK
status code with the updated blog post i.e.
or a 400 Bad Request
status code with error messages in case of validation errors. It should return a 404 Not Found
status code if the blog post was not found.
Delete an existing blog post using the DELETE
method
The endpoint should return a 204 No Content
status code if the blog post was successfully deleted or a 404 Not Found
status code if the blog post was not found.
Get a single blog post using the GET
method
The endpoint should return a 200 OK
status code with the blog post i.e.
or a 404 Not Found
status code if the blog post was not found.
Get all blog posts using the GET
method
The endpoint should return a 200 OK
status code with an array of blog posts i.e.
You don't have to implement pagination, authentication or authorization for this project. You can focus on the core functionality of the API.
While retrieving posts, user can also filter posts by a search term. You should do a wildcard search on the title, content or category fields of the blog posts. For example:
This should return all blog posts that have the term "tech" in their title, content or category. You can use a simple SQL query if you are using a SQL database or a similar query for a NoSQL database.
Feel free to use any programming language, framework, and database of your choice for this project. Here are some suggestions:
If you are using JavaScript, you can use Node.js with Express.js
If you are using Python, you can use Flask or Django
If you are using Java, you can use Spring Boot
If you are using Ruby, you can use Ruby on Rails
For databases, you can use:
MySQL if you are using SQL
MongoDB if you are using NoSQL
Join the Community
nlroot.isgood.host is the 6th most starred project on GitHub and is visited by hundreds of thousands of developers every month.
Roadmaps Best Practices Guides Videos FAQs YouTube
nlroot.isgood.host by @kamrify @kamrify
Community created roadmaps, best practices, projects, articles, resources and journeys to help you choose your path and grow in your career.
Login or Signup
You must be logged in to perform this action.