https://github.com/izzypt/dockerized_api
Advanced REST API with Python, Django REST Framework and Docker using Test Driven Development (TDD)
https://github.com/izzypt/dockerized_api
Last synced: about 2 months ago
JSON representation
Advanced REST API with Python, Django REST Framework and Docker using Test Driven Development (TDD)
- Host: GitHub
- URL: https://github.com/izzypt/dockerized_api
- Owner: izzypt
- Created: 2023-05-01T22:16:39.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-04T22:45:09.000Z (about 3 years ago)
- Last Synced: 2025-03-04T15:48:01.572Z (over 1 year ago)
- Language: Python
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Dockerized_API
Advanced REST API with Python, Django REST Framework and Docker using Test Driven Development (TDD)
## API Documentation
I'll be using ```DRF-Spectacular``` and ```swagger```, a 3rd party library, to automatically generate documentation for this API.
### How it works
- This tool generates a schema (a document in JSON or YML). This will allows use to create a browsable web interface.
- Generate schema file
- Parse schema into UI
The ```OpenAPI Schema``` is the standard for describing API's and the most popular.
We will also be using the SWAGGER tool.
## GIthub Actions
- WIll use github actions in order to run some automated tasks whenever we push changes to our project.
- A tool similar to Travis-CI, GitLab CI/CD, Jenkins...
- Allows you ro run jobs whenever your code changes..
### Common uses :
- Deployment
- Code linting
- Unit tests
### How it works
- Start by setting up a trigger (you set up which event you want)
- When the trigger occurs, you you run the jobs you have defined (For example, running unit tests).
### Configuring
- Create a config file at ```.github/workflows/checks.yml```
- Set trigerr
- Add steps for running testing and linting
## Docker hub
- Where you pull docker base images from to your local machine..