https://github.com/engageintellect/fast-api-mysql
https://github.com/engageintellect/fast-api-mysql
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/engageintellect/fast-api-mysql
- Owner: engageintellect
- Created: 2022-10-31T05:49:03.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-01T08:12:46.000Z (over 3 years ago)
- Last Synced: 2025-02-06T13:49:22.233Z (over 1 year ago)
- Language: Python
- Size: 14.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Fast API Demo
## Description:
FastAPI framework, high performance, easy to learn, fast to code, ready for production
## The key features are:
- **Fast** --> Very high performance, on par with NodeJS and Go (thanks to Starlette and Pydantic). One of the fastest Python frameworks available.
Fast to code: Increase the speed to develop features by about 200% to 300%.
- **Fewer bugs** --> Reduce about 40% of human (developer) induced errors.
- **Intuitive** --> Great editor support. Completion everywhere. Less time debugging.
- **Easy** --> Designed to be easy to use and learn. Less time reading docs.
- **Short** --> Minimize code duplication. Multiple features from each parameter declaration. Fewer bugs.
- **Robust** --> Get production-ready code. With automatic interactive documentation.
- **Standards-based** --> Based on (and fully compatible with) the open standards for APIs: OpenAPI (previously known as Swagger) and JSON Schema.
# Getting Started
1. clone repository
```
git clone
```
2. install dependencies
```
cd fast_api && sudo pip install -r requirements.txt
```
3. Setup MySQL
* Create a local MySQL database called "py_crud"
* Create a table like this one:
```sql
CREATE TABLE releases(
id int NOT NULL PRIMARY KEY AUTO_INCREMENT COMMENT 'Primary Key',
date VARCHAR(255),
title VARCHAR(255),
description VARCHAR(255),
link VARCHAR(255),
) COMMENT '';
```
3. run code (dev)
```
uvicorn main:app --reload
```
4. run code (prod)
```
uvicorn main:app --host localhost --port 3000
```
To keep a persistent connection, and to refesh during updates, add the ```--reload``` switch.
```
uvicorn main:app --host localhost --port 3000 --reload
```
4. test endpoints
* [/](http://localhost:3000)
* [/api/info](http://localhost:3000/api/info)
* [/api/release](http://localhost:3000/api/release)
* [/api/projects](http://localhost:3000/api/release)
* [/api/products](http://localhost:3000/api/release)
OR
* ```curl http://localhost:3000```
* ```curl http://localhost:3000/info```
* ```curl http://localhost:3000/release```
5. Additionally, FastAPI is self-documenting. You can access this by appending 'docs' to the end of an endpoint:
```
http://localhost:3000/docs
```
# Sending data externally using Python.
```python
import requests
url = "https://httpbin.org/post"
data = {
'date': 'date',
'title': 'title',
'description': 'desc',
'link': 'link',
}
response = requests.post(url, json=data)
print(f'Status: {response.status_code}\n Response: {response.json()}')
```
# Resources
* [YouTube Tutorial](https://www.youtube.com/watch?v=yEMbfK6f3aw&t=967s)