Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kiminzajnr/coding-school-api
Coding school api
https://github.com/kiminzajnr/coding-school-api
docker flask-smorest flask-sqlalchemy python3 swagger-ui
Last synced: 16 days ago
JSON representation
Coding school api
- Host: GitHub
- URL: https://github.com/kiminzajnr/coding-school-api
- Owner: kiminzajnr
- License: mit
- Created: 2024-07-01T15:01:15.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-08-04T10:19:47.000Z (6 months ago)
- Last Synced: 2024-11-09T16:16:17.821Z (2 months ago)
- Topics: docker, flask-smorest, flask-sqlalchemy, python3, swagger-ui
- Language: Python
- Homepage: https://coding-school-api.discoverwitherick.tech/swagger-ui
- Size: 63.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Coding School API
## About
This project is an API for a coding school designed to manage courses, projects, tasks, tags and users. It allows for CRUD operations on all entities, supports authentication, and includes detailed documentation.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Features](#features)
- [Endpoints](#endpoints)
- [Authentication](#authentication)
- [License](#license)
- [References](#references)
## Installation
### Prerequisites
- Python 3.8+
- pip
- Virtual environment
### Steps
1. Clone the repository:
```bash
git clone https://github.com/kiminzajnr/coding-school-api.git
cd coding-school-api
```
2. Create and activate a virtual environment:
```bash
python3 -m venv venv
. venv/bin/activate # On Windows, use `venv\Scripts\activate`
```
3. Install the dependencies:
```bash
pip install -r requirements.txt
```
4. Set up the database:
```bash
flask db init
flask db migrate
flask db upgrade
```
5. Run the application:
```bash
flask run
```
## Usage
### Examples
- To create a new user:
```bash
curl -X POST http://127.0.0.1:5000/register -d '{"username": "John", "password": "1234", "email": "[email protected]"}' -H "Content-Type: application/json"
```
- To get a list of courses:
```bash
curl http://127.0.0.1:5000/course
```
## Features
- Full CRUD operations for users, courses, projects, tasks, and tags.
- JWT authentication.
- Detailed API documentation using Swagger.
- Error handling and validation.
## Endpoints
### Users
- `GET /user/{user_id}`
- `POST /register`
- `POST /login`
- `POST /refresh`
- `POST /logout`
- `DELETE /user/{user_id}`
### Courses
- `GET /course`
- `GET /course/{course_id}`
- `POST /course`
- `DELETE /course/{course_id}`
### Projects
- `GET /project`
- `GET /project/{project_id}`
- `POST /project`
- `PUT /project/{project_id}`
- `DELETE /project/{project_id}`
### Tasks
- `GET /task`
- `GET /task/{task_id}`
- `POST /task`
- `PUT /task/{task_id}`
- `DELETE /task/{task_id}`
### Tags
- `GET /tag/{tag_id}`
- `GET /course/{course_id}/tag`
- `POST /course/{course_id}/tag`
- `POST /project/{project_id}/tag/{tag_id}`
- `DELETE /tag/{tag_id}`
- `DELETE /project/{project_id}/tag/{tag_id}`
## Authentication
This API uses JWT for authentication. To access protected routes, you need to include a valid token in the `Authorization` header:
```
Authorization: Bearer
```
## License
This project is licensed under the MIT License. See the [LICENSE](/LICENSE) file for details.
## References
- [Flask Documentation](https://flask.palletsprojects.com/en/3.0.x/)
- [flask-smorest](https://flask-smorest.readthedocs.io/en/latest/index.html)
- [Swagger Documentation](https://swagger.io/tools/swagger-ui)