https://github.com/haminimi/blog-api
A REST API for managing a blog site.
https://github.com/haminimi/blog-api
express nodejs rest rest-api theodinproject
Last synced: 7 months ago
JSON representation
A REST API for managing a blog site.
- Host: GitHub
- URL: https://github.com/haminimi/blog-api
- Owner: Haminimi
- Created: 2024-02-15T22:18:58.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-22T12:53:09.000Z (over 1 year ago)
- Last Synced: 2025-01-13T17:51:40.531Z (9 months ago)
- Topics: express, nodejs, rest, rest-api, theodinproject
- Language: JavaScript
- Homepage: https://haminimi-blog-api.glitch.me/api
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Blog API
## Description
A REST API for managing a blog site. [The project](https://www.theodinproject.com/lessons/nodejs-blog-api) is a part of [The Odin Project](https://www.theodinproject.com/dashboard)'s Node course within [The Odin Project](https://www.theodinproject.com/dashboard)'s curriculum. The Odin Project provides a high quality web development education maintained by an open source community.
## [Live Preview](https://haminimi-blog-api.glitch.me/api)
You can perform all CRUD operations on the API. The easiest ones to check are the GET requests in your browser. In order to retrieve a list of posts and authors, you can visit [/api/posts](https://haminimi-blog-api.glitch.me/api/posts) and [/api/authors](https://haminimi-blog-api.glitch.me/api/authors). For a list of comments for a specific post, you can use the next endpoint [/api/posts/:postId/comments](https://haminimi-blog-api.glitch.me/api/posts/65d0ad2ed0814d06706f37b8/comments) or to get a specific comment visit [/api/posts/:postId/comments/:commentId](https://haminimi-blog-api.glitch.me/api/posts/65d0ad2ed0814d06706f37b8/comments/65d0b5dc820417d7532c8d02).
Other CRUD operations may be tested using [cURL](https://curl.se/) or [Postman](https://www.postman.com/).
## Main Features
- **REST**
**To Do:**
- [ ] **Integrate With Frontend**
## Tech
**The project is built with:**
- Node.js/Express
- MongoDB
**Tools**
- Visual Studio Code
- Git
## Covered Topics
**This section mentions the main topics covered during project work and prior lessons**
- REST API
- JWT
## Reflection
A part of the project is building the frontend and connecting with the API. However, the main focus is on getting a REST API up and running. Currently, the project is a standalone API, but I will consider expanding and integrating it with my portfolio website in the future.
## Happy coding!