Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wannacry081/notehub-django
NoteHubAPI is a Django-based API for team note management. It offers user authentication, team handling, and note creation. It supports Swagger and Redoc for developer-friendly documentation.
https://github.com/wannacry081/notehub-django
django django-rest-framework drf-yasg python sqlite
Last synced: 9 days ago
JSON representation
NoteHubAPI is a Django-based API for team note management. It offers user authentication, team handling, and note creation. It supports Swagger and Redoc for developer-friendly documentation.
- Host: GitHub
- URL: https://github.com/wannacry081/notehub-django
- Owner: WannaCry081
- License: mit
- Created: 2024-02-13T09:42:28.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-06-29T07:14:06.000Z (5 months ago)
- Last Synced: 2024-06-29T08:27:12.227Z (5 months ago)
- Topics: django, django-rest-framework, drf-yasg, python, sqlite
- Language: Python
- Homepage:
- Size: 142 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## NoteHubAPI - Django
NoteHubAPI is a simple Django-based API designed for managing notes within teams. It provides functionality for user authentication, team management, and note creation. The API supports both Swagger and Redoc for documentation purposes, ensuring ease of use and understanding for developers.
### Packages Used
- Django: Web framework for building the API.
- Django Rest Framework (DRF): Toolkit for building Web APIs in Django.
- Django Rest Framework SimpleJWT: Token-based authentication for DRF.
- drf-yasg: Library for generating Swagger/OpenAPI documentation for DRF APIs.
### Authentication Endpoints
- **POST** `/api/v1/auth/login/`: Endpoint for user login.
- **POST** `/api/v1/auth/register/`: Endpoint for user registration.
- **POST** `/api/v1/auth/blacklist/`: Endpoint to blacklist tokens.
- **POST** `/api/v1/auth/refresh/`: Endpoint to refresh tokens.
### User Endpoints
- **GET** `/api/v1/users/`: Retrieve all users.
- **PUT** `/api/v1/users//`: Update user information.
- **PATCH** `/api/v1/users//`: Update specific user information.
- **DELETE** `/api/v1/users//`: Delete user.
- **GET** `/api/v1/users//teams/`: Retrieve teams associated with a user.
### Team Endpoints
- **GET** `/api/v1/teams/`: Retrieve all teams.
- **GET** `/api/v1/teams//`: Retrieve specific team.
- **POST** `/api/v1/teams/`: Create a new team.
- **POST** `/api/v1/teams//join/`: Join a team.
- **PUT** `/api/v1/teams//`: Update team information (permission required).
- **PATCH** `/api/v1/teams//`: Update specific team information (permission required).
- **DELETE** `/api/v1/teams//`: Delete team (permission required).
- **DELETE** `/api/v1/teams//leave/`: Leave a team.
### Note Endpoints
- **GET** `/api/v1/notes//`: Retrieve specific note.
- **PUT** `/api/v1/notes//`: Update note.
- **POST** `/api/v1/notes//`: Create new note.
- **PATCH** `/api/v1/notes//`: Update specific note information.
- **DELETE** `/api/v1/notes//`: Delete note.
### Installation
1. Clone the repository:
```bash
git clone https://github.com/WannaCry081/NoteHubAPI-Django.git
```
2. Install dependencies:
```bash
pip install -r requirements.txt
```
3. Apply migrations:
```bash
python manage.py migrate
```
4. Run the development server:
```bash
python manage.py runserver
```
### License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
### Contributing
Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines.