معرفی شرکت ها
django-mini-fastapi-0.1.9
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Minimal FastAPI implementation for Django
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | django-mini-fastapi-0.1.9 |
| نام | django-mini-fastapi |
| نسخه کتابخانه | 0.1.9 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | - |
| ایمیل نویسنده | toki <toki.kanno@gmail.com> |
| آدرس صفحه اصلی | - |
| آدرس اینترنتی | https://pypi.org/project/django-mini-fastapi/ |
| مجوز | - |
# Caution!!!
This is a minimal FastAPI port for Django, not all of FastAPI functionalities are supported.
Please see [Features currently work](#features-currently-work) and [Features currently not work](#features-currently-not-work) sections to evaluate if all the functionalities you need are ported.
Also, bug reports / Fix PRs are welcomed.
# Installation
```sh
pip install django-mini-fastapi
```
# Live demo provided by Gitpod
Click the button below and launch a free live demo server via Gitpod
[](https://gitpod.io/#https://github.com/tokikanno/django-mini-fastapi)
If the button doesn't show up, you clould also use below link directly
[https://gitpod.io/#https://github.com/tokikanno/django-mini-fastapi](https://gitpod.io/#https://github.com/tokikanno/django-mini-fastapi)
After Gitpod launched, wait a while for the auto execution of `make intro` command
Then you could using VScode remote explorer for opening the intro demo server in your browser.
# What is `django-mini-fastapi` ?
A minimal FastAPI implementation for Django !
This project reused more than 95% codes from [FastAPI](https://fastapi.tiangolo.com/). I just did minimal necessary modifications for making it working under Django.
So basicly you can read documents from FastAPI for knowing how to use this module. (Except features metioned in `Features currently not work` section)
The major difference between django-mini-fastapi and FastAPI is how you import and mount it.
```python
# This is how you declear OpenAPI endpoint in FastAPI
from typing import Optional
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
def read_root():
return {"Hello": "World"}
@app.get("/items/{item_id}")
def read_item(item_id: int, q: Optional[str] = None):
return {"item_id": item_id, "q": q}
```
Above is the quick start sample in FastAPI document, which should be re-written like below
```python
# This is how you do the same thing in django-mini-fastapi
from typing import Optional
from django_mini_fastapi import OpenAPI
app = OpenAPI()
@app.get("/")
def read_root():
return {"Hello": "World"}
@app.get("/items/{item_id}")
def read_item(item_id: int, q: Optional[str] = None):
return {"item_id": item_id, "q": q}
```
And you should mount the API endpoint via Django url pattern mechanism by calling `app.as_django_url_pattern()`
```python
urlpatterns = [
# use as_django_url_pattern() for mounting API endpoint into Django url parser
app.as_django_url_pattern(),
]
```
And usually you won't want to mount API endpoint in `/` for a Django project. You could pass the `root_path` parameter to OpenAPI init function for changing the mount point.
```python
app = OpenAPI(root_path='/api')
```
For fully working example script, please see [demo/intro.py](https://github.com/tokikanno/django-mini-fastapi/blob/master/demo/intro.py)
You can also type
```sh
make intro
```
for starting test intro server.
# Why do you make this? Can't you just use FastAPI directly?
I'm a big fan of FastAPI. It's elegant and saves lots of doc maintaince & API spec communication costs for me.
But I'm maintaing huge legacy projects built by Django framework. It will take massive resources for porting it onto FastAPI.
So I decided to modifiy FastAPI for making it working under Django, then I could instantly get the benefits from FastAPI without doing migrations for my legacy projects.
# Who should use this?
People who like the way FastAPI works but don't want to do full system rewrite from Django to FastAPI
# Features currently work
* Auto OpenAPI schema/document generation from Python function declaration
* Auto request parameter validation
* Dependencies system
* Authentication (Security dependencies)
# Features currently not work
* Auto OpenAPI parameters parsing & processing
* Callback function delcearation (WIP)
* ~~Security dependencies (Evaluating/Planning)~~ (done)
* WebSocket endpoints (Not in priority)
* Backgournd tasks (Not in priority, we still use celery even using the real FastAPI. Background task execution function in FastAPI isn't very suitable for serious tasks.)
نیازمندی
| مقدار | نام |
|---|---|
| - | django |
| =1.6.2,!=1.7,!=1.7.1,!=1.7.2,!=1.7.3,!=1.8,!=1.8.1,<2.0. | pydantic |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.6 | Python |
نحوه نصب
نصب پکیج whl django-mini-fastapi-0.1.9:
pip install django-mini-fastapi-0.1.9.whl
نصب پکیج tar.gz django-mini-fastapi-0.1.9:
pip install django-mini-fastapi-0.1.9.tar.gz