Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itsluisjim/blog-api
Blog API
https://github.com/itsluisjim/blog-api
api express jwt-authentication mondodb mongoose nodejs rest-api swagger
Last synced: about 15 hours ago
JSON representation
Blog API
- Host: GitHub
- URL: https://github.com/itsluisjim/blog-api
- Owner: itsluisjim
- Created: 2024-03-13T20:26:04.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-04-29T01:29:14.000Z (7 months ago)
- Last Synced: 2024-04-30T01:36:19.568Z (7 months ago)
- Topics: api, express, jwt-authentication, mondodb, mongoose, nodejs, rest-api, swagger
- Language: JavaScript
- Homepage:
- Size: 214 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# REST API with Node.js, Express, and MongoDB
## Blogaway - A blogging platform
**Project Goal:**
The goal of this project was to build a robust and secure REST API using Node.js, Express, and MongoDB. The API would follow best practices for RESTful design and include features such as JWT-based authentication and authorization. Used Swagger to document API endpoints.
**BlogAway User Interface:** View Repo
**Technologies Used:**
- : A JavaScript runtime environment that allows developers to run JavaScript on the server-side.
- : A popular web application framework for Node.js, which simplifies the process of building web servers and APIs.
- 
: A popular NoSQL database that stores data in flexible, JSON-like documents.
- **JSON Web Tokens (JWT)**: An open standard for securely transmitting information between parties as a JSON object.
**Key Features:**
1. **RESTful Design**: The API was designed to follow RESTful principles, ensuring a clear and intuitive structure for the endpoints, HTTP methods, and data responses.
2. **JWT-based Authentication and Authorization**: The API implemented a JWT-based authentication and authorization system. Users can register and log in, and the API uses signed JWT tokens to authenticate and authorize requests.
3. **CRUD Operations**: The API supports standard CRUD (Create, Read, Update, Delete) operations for various resources, such as authors, blogs etc.
4. **Data Persistence with MongoDB**: The API uses MongoDB as the database to store and retrieve data. MongoDB's flexible document-oriented data model is well-suited for the API's requirements.
5. **Error Handling and Response Formatting**: The API includes robust error handling mechanisms, providing clear and informative error messages to clients. Responses are consistently formatted, often in JSON format.
6. **Security Practices**: The API follows security best practices, such as hashing passwords, validating inputs, and protecting against common web vulnerabilities like CSRF and XSS.
**Project Structure and Organization:**
The project is structured in a modular and maintainable way, with the following key components:
- **Routes**: Responsible for handling incoming requests and mapping them to the appropriate controller functions.
- **Controllers**: Contain the business logic for processing requests and interacting with the database.
- **Models**: Represent the data structures and schemas used in the API, leveraging Mongoose (an Object Document Mapping library for MongoDB).
- **Middleware**: Handles cross-cutting concerns, such as authentication, authorization, and error handling.
- **Utilities**: Includes helper functions, configuration settings, and other supporting code.
### Future Work:
- Allow users to upload their own profile images.
- Allow users to change their email.