Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wannacry081/noteapp-flask-api
The NoteApp API is a RESTful API developed using Flask, Flask-SQLAlchemy, Flask-JWT-Extended, Flask-Bcrypt, and Flask-Marshmallow. This API allows users to manage notes by providing endpoints for creating, retrieving, updating, and deleting notes.
https://github.com/wannacry081/noteapp-flask-api
api flask flask-bcrypt flask-jwt-extended flask-marshmallow flask-restful flask-sqlalchemy
Last synced: 7 days ago
JSON representation
The NoteApp API is a RESTful API developed using Flask, Flask-SQLAlchemy, Flask-JWT-Extended, Flask-Bcrypt, and Flask-Marshmallow. This API allows users to manage notes by providing endpoints for creating, retrieving, updating, and deleting notes.
- Host: GitHub
- URL: https://github.com/wannacry081/noteapp-flask-api
- Owner: WannaCry081
- License: other
- Created: 2023-06-21T13:25:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-09T02:20:24.000Z (over 1 year ago)
- Last Synced: 2023-09-16T19:25:38.522Z (about 1 year ago)
- Topics: api, flask, flask-bcrypt, flask-jwt-extended, flask-marshmallow, flask-restful, flask-sqlalchemy
- Language: Python
- Homepage:
- Size: 90.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NoteApp API
This repository contains a simple NoteApp API developed using Python and the Flask framework. It provides basic CRUD (Create, Read, Update, Delete) operations for managing notes. The API is built with the following Python libraries: Flask, Flask-Restful, Flask-SQLAlchemy, Flask-JWT-Extended, Flask-Marshmallow, Flask-Cors, Flask-Bcrypt, and MySQLclient.
## Features
- User authentication and authorization
- User management (update password, get user information, update user information, delete user account)
- Note management (create note, get all notes of a user, get specific note information, update note, delete note)
- Unit testing
## Prerequisites
To run this API locally, you need to have the following dependencies installed:
- Python (version >= 3.10.0)
- Flask (version >= 2.0.0)
- Flask-SQLAlchemy
- Flask-JWT-Extended
- Flask-Marshmallow
- Flask-Cors
- Flask-Bcrypt
- MySQLclient
## Installation
1. Clone this repository to your local machine.
```bash
git clone https://github.com/TheDayDreamer01/NoteApp-Flask-API.git
```
2. Change into the project's directory.
```bash
cd noteapp-flask-api
```
3. (Optional) Create a virtual environment.
```bash
virtualenv env
source venv/bin/activate
```
4. Install the required dependencies.
```bash
pip install -r requirements.txt
```
5. Start the API server.
```bash
python server.py
```
By default, the API will use SQLite3 as the database for the development and testing environment. If you want to use MySQL for the production environment, please update the database configuration accordingly in the `./App/config.py`.
## API Routes
The following routes are available in the NoteApp API:
### Authentication
- `POST /api/auth/signin`: Login a user
- `POST /api/auth/signup`: Sign up a user
- `POST /api/auth/signout`: Sign out the current user
- `POST /api/auth/refresh`: Refresh access token using refresh token
- `POST /api/auth/refresh/signout`: Sign out using the refresh token
### User Management
- `POST /api/user/`: Update user password
- `GET /api/user/`: Get current user information
- `PUT /api/user/`: Update basic information of the user
- `DELETE /api/user/`: Delete the user account
### Note Management
- `GET /api/note/`: Get all notes of the current user
- `POST /api/note/`: Create a new note
- `GET /api/note///`: Get specific information of a note
- `PUT /api/note///`: Update a note
- `DELETE /api/note///`: Delete a note
## Unit Testing
Unit tests for the NoteApp API are located in the `Test` directory. To run the tests, execute the following command:
```shell
python -m unittest discover -s Test
```
## Contributing
Contributions to this NoteApp API are welcome! If you find any issues or want to suggest improvements, please create a new issue or submit a pull request.
## License
This project is licensed under the [MIT License](LICENSE). Feel free to use and modify the code as per your needs.