معرفی شرکت ها
fastapi-restify-0.0.4
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Rest API configured with pydantic, backed by file database or mongo
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | fastapi-restify-0.0.4 |
| نام | fastapi-restify |
| نسخه کتابخانه | 0.0.4 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Steve Ryan |
| ایمیل نویسنده | syntithenai@gmail.com |
| آدرس صفحه اصلی | https://github.com/syntithenai/fastapi_restify |
| آدرس اینترنتی | https://pypi.org/project/fastapi-restify/ |
| مجوز | MIT |
# FastAPI Restify
[](https://github.com/syntithenai/fastapi_restify/actions/workflows/python-app.yml)
This project helps create a restful api using FastAPI and pydantic with storage engines including file and mongodb.
The project uses pydantic to map incoming request body data into a storage format.
The project provides
- File database implementing list, get, insert, update, replace, delete
- Mongo database implementing list, get, insert, update, replace, delete
- FastAPI router with routes for each HTTP verb get, post, put, patch, delete
- Authentication helpers including a FastAPI router for login and create user plus a token_listener dependancy for ensuring login on a route
This project is based on the example provided by https://github.com/Youngestdev/fastapi-mongo.
## Usage
1. First up install the package
```pip install fastapi_mongo_restify```
2. Then create a model object that extends MongoDatabase (or FileDatabase)
- provides pydantic model classes as class variables, updateModelClass and insertModelClass.
The insert model is applied to parsing POST requests and the update model is used for PUT/PATCH requests.
- calls super().__init('collectionName') in it's constructor
```
from fastapi_restify.mongo_database import MongoDatabase
from pydantic import BaseModel, EmailStr, Field
# used to map request parameters on insert/post
class InsertOrderModel(BaseModel):
name : str
status: str
time_started: int
time_completed: int
# used to map request parameters on update/put
class UpdateOrderModel(BaseModel):
id: int = Field(..., alias='_id') # update model needs an id field aliased to _id
name : str
status: str
time_started: int
time_completed: int
class OrdersModel(MongoDatabase):
# used by router for parameter mapping
updateModelClass = UpdateOrderModel
insertModelClass = InsertOrderModel
def __init__(self, name = 'orders'):
super().__init__(name)
```
3. Use the restify router in your app, passing an instance of your model to the router and specifying the url prefix.
```
from fastapi import FastAPI, Depends
from fastapi_restify.restful_router import get_router
from orders_model_mongo import OrdersModel
orders_model = OrdersModel()
app = FastAPI(title='Test FastAPI Mongo Restify')
app.include_router(get_router(orders_model), tags=["Orders"], prefix="/orders")
```
4. start your app with uvicorn
```
import uvicorn
if __name__ == '__main__':
uvicorn.run('app:app', host="0.0.0.0", port=8080, reload=True)
```
5. Open [http://localhost:8080/docs](http://localhost:8080/docs) to see the FASTAPI generated documentation for your API.
## Authentication
To use authentication, include the admin router and token_listener.
!! Note that authentication is incomplete and create_user is exposed as a public endpoint.
```
from fastapi_restify.auth.jwt_bearer import JWTBearer
from fastapi_restify.auth.admin_router import router as AdminRouter
app.include_router(AdminRouter, tags=["Administrator"], prefix="/admin")
token_listener = JWTBearer()
# protect the products endpoint
app.include_router(get_router(products_model), tags=["Products"], prefix="/products" , dependencies=[Depends(token_listener)])
```
## Change Callbacks
The database classes can be called with a dict of callbacks with keys insert, update, replace, delete . When a data modification is applied the callback is triggered with dict parameter including modification type and modified record.
This behavior is intended to facilitate websocket streaming of changes posted through the restful API.
## TODO
https://pynamodb.readthedocs.io/en/latest/local.html
نیازمندی
| مقدار | نام |
|---|---|
| - | motor |
| - | PyJWT |
| - | bcrypt |
| - | uvicorn |
| - | pymongo |
| - | python-decouple |
| - | fastapi |
| - | pydantic[email] |
| - | passlib |
| - | pytest |
| - | jinja2 |
| - | aiofiles |
| - | requests |
| - | pymongo-inmemory |
نحوه نصب
نصب پکیج whl fastapi-restify-0.0.4:
pip install fastapi-restify-0.0.4.whl
نصب پکیج tar.gz fastapi-restify-0.0.4:
pip install fastapi-restify-0.0.4.tar.gz