Lorhan Sohaky
3 years ago
committed by
GitHub
GitHub
418 changed files with 5367 additions and 1540 deletions
@ -0,0 +1,16 @@ |
|||||
|
version: 2 |
||||
|
updates: |
||||
|
# GitHub Actions |
||||
|
- package-ecosystem: "github-actions" |
||||
|
directory: "/" |
||||
|
schedule: |
||||
|
interval: "daily" |
||||
|
commit-message: |
||||
|
prefix: ⬆ |
||||
|
# Python |
||||
|
- package-ecosystem: "pip" |
||||
|
directory: "/" |
||||
|
schedule: |
||||
|
interval: "daily" |
||||
|
commit-message: |
||||
|
prefix: ⬆ |
||||
@ -0,0 +1,51 @@ |
|||||
|
# See https://pre-commit.com for more information |
||||
|
# See https://pre-commit.com/hooks.html for more hooks |
||||
|
repos: |
||||
|
- repo: https://github.com/pre-commit/pre-commit-hooks |
||||
|
rev: v4.3.0 |
||||
|
hooks: |
||||
|
- id: check-added-large-files |
||||
|
- id: check-toml |
||||
|
- id: check-yaml |
||||
|
args: |
||||
|
- --unsafe |
||||
|
- id: end-of-file-fixer |
||||
|
- id: trailing-whitespace |
||||
|
- repo: https://github.com/asottile/pyupgrade |
||||
|
rev: v2.37.1 |
||||
|
hooks: |
||||
|
- id: pyupgrade |
||||
|
args: |
||||
|
- --py3-plus |
||||
|
- --keep-runtime-typing |
||||
|
- repo: https://github.com/myint/autoflake |
||||
|
rev: v1.4 |
||||
|
hooks: |
||||
|
- id: autoflake |
||||
|
args: |
||||
|
- --recursive |
||||
|
- --in-place |
||||
|
- --remove-all-unused-imports |
||||
|
- --remove-unused-variables |
||||
|
- --expand-star-imports |
||||
|
- --exclude |
||||
|
- __init__.py |
||||
|
- --remove-duplicate-keys |
||||
|
- repo: https://github.com/pycqa/isort |
||||
|
rev: 5.10.1 |
||||
|
hooks: |
||||
|
- id: isort |
||||
|
name: isort (python) |
||||
|
- id: isort |
||||
|
name: isort (cython) |
||||
|
types: [cython] |
||||
|
- id: isort |
||||
|
name: isort (pyi) |
||||
|
types: [pyi] |
||||
|
- repo: https://github.com/psf/black |
||||
|
rev: 22.6.0 |
||||
|
hooks: |
||||
|
- id: black |
||||
|
ci: |
||||
|
autofix_commit_msg: 🎨 [pre-commit.ci] Auto format from pre-commit.com hooks |
||||
|
autoupdate_commit_msg: ⬆ [pre-commit.ci] pre-commit autoupdate |
||||
|
After Width: | Height: | Size: 36 KiB |
|
After Width: | Height: | Size: 52 KiB |
|
After Width: | Height: | Size: 91 KiB |
|
Before Width: | Height: | Size: 5.2 KiB After Width: | Height: | Size: 10 KiB |
|
After Width: | Height: | Size: 105 KiB |
|
After Width: | Height: | Size: 106 KiB |
|
After Width: | Height: | Size: 14 KiB |
|
After Width: | Height: | Size: 26 KiB |
@ -0,0 +1,464 @@ |
|||||
|
<p align="center"> |
||||
|
<a href="https://fastapi.tiangolo.com"><img src="https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png" alt="FastAPI"></a> |
||||
|
</p> |
||||
|
<p align="center"> |
||||
|
<em>תשתית FastAPI, ביצועים גבוהים, קלה ללמידה, מהירה לתכנות, מוכנה לסביבת ייצור</em> |
||||
|
</p> |
||||
|
<p align="center"> |
||||
|
<a href="https://github.com/tiangolo/fastapi/actions?query=workflow%3ATest+event%3Apush+branch%3Amaster" target="_blank"> |
||||
|
<img src="https://github.com/tiangolo/fastapi/workflows/Test/badge.svg?event=push&branch=master" alt="Test"> |
||||
|
</a> |
||||
|
<a href="https://codecov.io/gh/tiangolo/fastapi" target="_blank"> |
||||
|
<img src="https://img.shields.io/codecov/c/github/tiangolo/fastapi?color=%2334D058" alt="Coverage"> |
||||
|
</a> |
||||
|
<a href="https://pypi.org/project/fastapi" target="_blank"> |
||||
|
<img src="https://img.shields.io/pypi/v/fastapi?color=%2334D058&label=pypi%20package" alt="Package version"> |
||||
|
</a> |
||||
|
<a href="https://pypi.org/project/fastapi" target="_blank"> |
||||
|
<img src="https://img.shields.io/pypi/pyversions/fastapi.svg?color=%2334D058" alt="Supported Python versions"> |
||||
|
</a> |
||||
|
</p> |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
**תיעוד**: <a href="https://fastapi.tiangolo.com" target="_blank">https://fastapi.tiangolo.com</a> |
||||
|
|
||||
|
**קוד**: <a href="https://github.com/tiangolo/fastapi" target="_blank">https://github.com/tiangolo/fastapi</a> |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
FastAPI היא תשתית רשת מודרנית ומהירה (ביצועים גבוהים) לבניית ממשקי תכנות יישומים (API) עם פייתון 3.6+ בהתבסס על רמזי טיפוסים סטנדרטיים. |
||||
|
|
||||
|
תכונות המפתח הן: |
||||
|
|
||||
|
- **מהירה**: ביצועים גבוהים מאוד, בקנה אחד עם NodeJS ו - Go (תודות ל - Starlette ו - Pydantic). [אחת מתשתיות הפייתון המהירות ביותר](#performance). |
||||
|
|
||||
|
- **מהירה לתכנות**: הגבירו את מהירות פיתוח התכונות החדשות בכ - %200 עד %300. \* |
||||
|
- **פחות שגיאות**: מנעו כ - %40 משגיאות אנוש (מפתחים). \* |
||||
|
- **אינטואיטיבית**: תמיכת עורך מעולה. <abbr title="ידועה גם כהשלמה אוטומטית או IntelliSense">השלמה</abbr> בכל מקום. פחות זמן ניפוי שגיאות. |
||||
|
- **קלה**: מתוכננת להיות קלה לשימוש וללמידה. פחות זמן קריאת תיעוד. |
||||
|
- **קצרה**: מזערו שכפול קוד. מספר תכונות מכל הכרזת פרמטר. פחות שגיאות. |
||||
|
- **חסונה**: קבלו קוד מוכן לסביבת ייצור. עם תיעוד אינטרקטיבי אוטומטי. |
||||
|
- **מבוססת סטנדרטים**: מבוססת על (ותואמת לחלוטין ל -) הסטדנרטים הפתוחים לממשקי תכנות יישומים: <a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank">OpenAPI</a> (ידועים לשעבר כ - Swagger) ו - <a href="https://json-schema.org/" class="external-link" target="_blank">JSON Schema</a>. |
||||
|
|
||||
|
<small>\* הערכה מבוססת על בדיקות של צוות פיתוח פנימי שבונה אפליקציות בסביבת ייצור.</small> |
||||
|
|
||||
|
## נותני חסות |
||||
|
|
||||
|
<!-- sponsors --> |
||||
|
|
||||
|
{% if sponsors %} |
||||
|
{% for sponsor in sponsors.gold -%} |
||||
|
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a> |
||||
|
{% endfor -%} |
||||
|
{%- for sponsor in sponsors.silver -%} |
||||
|
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a> |
||||
|
{% endfor %} |
||||
|
{% endif %} |
||||
|
|
||||
|
<!-- /sponsors --> |
||||
|
|
||||
|
<a href="https://fastapi.tiangolo.com/fastapi-people/#sponsors" class="external-link" target="_blank">נותני חסות אחרים</a> |
||||
|
|
||||
|
## דעות |
||||
|
|
||||
|
"_[...] I'm using **FastAPI** a ton these days. [...] I'm actually planning to use it for all of my team's **ML services at Microsoft**. Some of them are getting integrated into the core **Windows** product and some **Office** products._" |
||||
|
|
||||
|
<div style="text-align: right; margin-right: 10%;">Kabir Khan - <strong>Microsoft</strong> <a href="https://github.com/tiangolo/fastapi/pull/26" target="_blank"><small>(ref)</small></a></div> |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
"_We adopted the **FastAPI** library to spawn a **REST** server that can be queried to obtain **predictions**. [for Ludwig]_" |
||||
|
|
||||
|
<div style="text-align: right; margin-right: 10%;">Piero Molino, Yaroslav Dudin, and Sai Sumanth Miryala - <strong>Uber</strong> <a href="https://eng.uber.com/ludwig-v0-2/" target="_blank"><small>(ref)</small></a></div> |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
"_**Netflix** is pleased to announce the open-source release of our **crisis management** orchestration framework: **Dispatch**! [built with **FastAPI**]_" |
||||
|
|
||||
|
<div style="text-align: right; margin-right: 10%;">Kevin Glisson, Marc Vilanova, Forest Monsen - <strong>Netflix</strong> <a href="https://netflixtechblog.com/introducing-dispatch-da4b8a2a8072" target="_blank"><small>(ref)</small></a></div> |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
"_I’m over the moon excited about **FastAPI**. It’s so fun!_" |
||||
|
|
||||
|
<div style="text-align: right; margin-right: 10%;">Brian Okken - <strong><a href="https://pythonbytes.fm/episodes/show/123/time-to-right-the-py-wrongs?time_in_sec=855" target="_blank">Python Bytes</a> podcast host</strong> <a href="https://twitter.com/brianokken/status/1112220079972728832" target="_blank"><small>(ref)</small></a></div> |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
"_Honestly, what you've built looks super solid and polished. In many ways, it's what I wanted **Hug** to be - it's really inspiring to see someone build that._" |
||||
|
|
||||
|
<div style="text-align: right; margin-right: 10%;">Timothy Crosley - <strong><a href="https://www.hug.rest/" target="_blank">Hug</a> creator</strong> <a href="https://news.ycombinator.com/item?id=19455465" target="_blank"><small>(ref)</small></a></div> |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
"_If you're looking to learn one **modern framework** for building REST APIs, check out **FastAPI** [...] It's fast, easy to use and easy to learn [...]_" |
||||
|
|
||||
|
"_We've switched over to **FastAPI** for our **APIs** [...] I think you'll like it [...]_" |
||||
|
|
||||
|
<div style="text-align: right; margin-right: 10%;">Ines Montani - Matthew Honnibal - <strong><a href="https://explosion.ai" target="_blank">Explosion AI</a> founders - <a href="https://spacy.io" target="_blank">spaCy</a> creators</strong> <a href="https://twitter.com/_inesmontani/status/1144173225322143744" target="_blank"><small>(ref)</small></a> - <a href="https://twitter.com/honnibal/status/1144031421859655680" target="_blank"><small>(ref)</small></a></div> |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
## **Typer**, ה - FastAPI של ממשקי שורת פקודה (CLI). |
||||
|
|
||||
|
<a href="https://typer.tiangolo.com" target="_blank"><img src="https://typer.tiangolo.com/img/logo-margin/logo-margin-vector.svg" style="width: 20%;"></a> |
||||
|
|
||||
|
אם אתם בונים אפליקציית <abbr title="ממשק שורת פקודה">CLI</abbr> לשימוש במסוף במקום ממשק רשת, העיפו מבט על <a href="https://typer.tiangolo.com/" class="external-link" target="_blank">**Typer**</a>. |
||||
|
|
||||
|
**Typer** היא אחותה הקטנה של FastAPI. ומטרתה היא להיות ה - **FastAPI של ממשקי שורת פקודה**. ⌨️ 🚀 |
||||
|
|
||||
|
## תלויות |
||||
|
|
||||
|
פייתון 3.6+ |
||||
|
|
||||
|
FastAPI עומדת על כתפי ענקיות: |
||||
|
|
||||
|
- <a href="https://www.starlette.io/" class="external-link" target="_blank">Starlette</a> לחלקי הרשת. |
||||
|
- <a href="https://pydantic-docs.helpmanual.io/" class="external-link" target="_blank">Pydantic</a> לחלקי המידע. |
||||
|
|
||||
|
## התקנה |
||||
|
|
||||
|
<div dir="ltr" class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ pip install fastapi |
||||
|
|
||||
|
---> 100% |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
תצטרכו גם שרת ASGI כגון <a href="https://www.uvicorn.org" class="external-link" target="_blank">Uvicorn</a> או <a href="https://gitlab.com/pgjones/hypercorn" class="external-link" target="_blank">Hypercorn</a>. |
||||
|
|
||||
|
<div dir="ltr" class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ pip install "uvicorn[standard]" |
||||
|
|
||||
|
---> 100% |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
## דוגמא |
||||
|
|
||||
|
### צרו אותה |
||||
|
|
||||
|
- צרו קובץ בשם `main.py` עם: |
||||
|
|
||||
|
```Python |
||||
|
from typing import Union |
||||
|
|
||||
|
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: Union[str, None] = None): |
||||
|
return {"item_id": item_id, "q": q} |
||||
|
``` |
||||
|
|
||||
|
<details markdown="1"> |
||||
|
<summary>או השתמשו ב - <code>async def</code>...</summary> |
||||
|
|
||||
|
אם הקוד שלכם משתמש ב - `async` / `await`, השתמשו ב - `async def`: |
||||
|
|
||||
|
```Python hl_lines="9 14" |
||||
|
from typing import Union |
||||
|
|
||||
|
from fastapi import FastAPI |
||||
|
|
||||
|
app = FastAPI() |
||||
|
|
||||
|
|
||||
|
@app.get("/") |
||||
|
async def read_root(): |
||||
|
return {"Hello": "World"} |
||||
|
|
||||
|
|
||||
|
@app.get("/items/{item_id}") |
||||
|
async def read_item(item_id: int, q: Union[str, None] = None): |
||||
|
return {"item_id": item_id, "q": q} |
||||
|
``` |
||||
|
|
||||
|
**שימו לב**: |
||||
|
|
||||
|
אם אינכם יודעים, בדקו את פרק "ממהרים?" על <a href="https://fastapi.tiangolo.com/async/#in-a-hurry" target="_blank">`async` ו - `await` בתיעוד</a>. |
||||
|
|
||||
|
</details> |
||||
|
|
||||
|
### הריצו אותה |
||||
|
|
||||
|
התחילו את השרת עם: |
||||
|
|
||||
|
<div dir="ltr" class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ uvicorn main:app --reload |
||||
|
|
||||
|
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) |
||||
|
INFO: Started reloader process [28720] |
||||
|
INFO: Started server process [28722] |
||||
|
INFO: Waiting for application startup. |
||||
|
INFO: Application startup complete. |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
<details markdown="1"> |
||||
|
<summary>על הפקודה <code>uvicorn main:app --reload</code>...</summary> |
||||
|
|
||||
|
הפקודה `uvicorn main:app` מתייחסת ל: |
||||
|
|
||||
|
- `main`: הקובץ `main.py` (מודול פייתון). |
||||
|
- `app`: האובייקט שנוצר בתוך `main.py` עם השורה <code dir="ltr">app = FastAPI()</code>. |
||||
|
- <code dir="ltr">--reload</code>: גרמו לשרת להתאתחל לאחר שינויים בקוד. עשו זאת רק בסביבת פיתוח. |
||||
|
|
||||
|
</details> |
||||
|
|
||||
|
### בדקו אותה |
||||
|
|
||||
|
פתחו את הדפדפן שלכם בכתובת <a href="http://127.0.0.1:8000/items/5?q=somequery" class="external-link" target="_blank">http://127.0.0.1:8000/items/5?q=somequery</a>. |
||||
|
|
||||
|
אתם תראו תגובת JSON: |
||||
|
|
||||
|
```JSON |
||||
|
{"item_id": 5, "q": "somequery"} |
||||
|
``` |
||||
|
|
||||
|
כבר יצרתם API ש: |
||||
|
|
||||
|
- מקבל בקשות HTTP בנתיבים `/` ו - <code dir="ltr">/items/{item_id}</code>. |
||||
|
- שני ה _נתיבים_ מקבלים _בקשות_ `GET` (ידועות גם כ*מתודות* HTTP). |
||||
|
- ה _נתיב_ <code dir="ltr">/items/{item_id}</code> כולל \*פרמטר נתיב\_ `item_id` שאמור להיות `int`. |
||||
|
- ה _נתיב_ <code dir="ltr">/items/{item_id}</code> \*פרמטר שאילתא\_ אופציונלי `q`. |
||||
|
|
||||
|
### תיעוד API אינטרקטיבי |
||||
|
|
||||
|
כעת פנו לכתובת <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>. |
||||
|
|
||||
|
אתם תראו את התיעוד האוטומטי (מסופק על ידי <a href="https://github.com/swagger-api/swagger-ui" class="external-link" target="_blank">Swagger UI</a>): |
||||
|
|
||||
|
 |
||||
|
|
||||
|
### תיעוד אלטרנטיבי |
||||
|
|
||||
|
כעת פנו לכתובת <a href="http://127.0.0.1:8000/redoc" class="external-link" target="_blank">http://127.0.0.1:8000/redoc</a>. |
||||
|
|
||||
|
אתם תראו תיעוד אלטרנטיבי (מסופק על ידי <a href="https://github.com/Rebilly/ReDoc" class="external-link" target="_blank">ReDoc</a>): |
||||
|
|
||||
|
 |
||||
|
|
||||
|
## שדרוג לדוגמא |
||||
|
|
||||
|
כעת ערכו את הקובץ `main.py` כך שיוכל לקבל גוף מבקשת `PUT`. |
||||
|
|
||||
|
הגדירו את הגוף בעזרת רמזי טיפוסים סטנדרטיים, הודות ל - `Pydantic`. |
||||
|
|
||||
|
```Python hl_lines="4 9-12 25-27" |
||||
|
from typing import Union |
||||
|
|
||||
|
from fastapi import FastAPI |
||||
|
from pydantic import BaseModel |
||||
|
|
||||
|
app = FastAPI() |
||||
|
|
||||
|
|
||||
|
class Item(BaseModel): |
||||
|
name: str |
||||
|
price: float |
||||
|
is_offer: Union[bool, None] = None |
||||
|
|
||||
|
|
||||
|
@app.get("/") |
||||
|
def read_root(): |
||||
|
return {"Hello": "World"} |
||||
|
|
||||
|
|
||||
|
@app.get("/items/{item_id}") |
||||
|
def read_item(item_id: int, q: Union[str, None] = None): |
||||
|
return {"item_id": item_id, "q": q} |
||||
|
|
||||
|
|
||||
|
@app.put("/items/{item_id}") |
||||
|
def update_item(item_id: int, item: Item): |
||||
|
return {"item_name": item.name, "item_id": item_id} |
||||
|
``` |
||||
|
|
||||
|
השרת אמול להתאתחל אוטומטית (מאחר והוספתם <code dir="ltr">--reload</code> לפקודת `uvicorn` שלמעלה). |
||||
|
|
||||
|
### שדרוג התיעוד האינטרקטיבי |
||||
|
|
||||
|
כעת פנו לכתובת <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>. |
||||
|
|
||||
|
- התיעוד האוטומטי יתעדכן, כולל הגוף החדש: |
||||
|
|
||||
|
 |
||||
|
|
||||
|
- לחצו על הכפתור "Try it out", הוא יאפשר לכם למלא את הפרמטרים ולעבוד ישירות מול ה - API. |
||||
|
|
||||
|
 |
||||
|
|
||||
|
- אחר כך לחצו על הכפתור "Execute", האתר יתקשר עם ה - API שלכם, ישלח את הפרמטרים, ישיג את התוצאות ואז יראה אותן על המסך: |
||||
|
|
||||
|
 |
||||
|
|
||||
|
### שדרוג התיעוד האלטרנטיבי |
||||
|
|
||||
|
כעת פנו לכתובת <a href="http://127.0.0.1:8000/redoc" class="external-link" target="_blank">http://127.0.0.1:8000/redoc</a>. |
||||
|
|
||||
|
- התיעוד האלטרנטיבי גם יראה את פרמטר השאילתא והגוף החדשים. |
||||
|
|
||||
|
 |
||||
|
|
||||
|
### סיכום |
||||
|
|
||||
|
לסיכום, אתם מכריזים ** פעם אחת** על טיפוסי הפרמטרים, גוף וכו' כפרמטרים לפונקציה. |
||||
|
|
||||
|
אתם עושים את זה עם טיפוסי פייתון מודרניים. |
||||
|
|
||||
|
אתם לא צריכים ללמוד תחביר חדש, מתודות או מחלקות של ספרייה ספיציפית, וכו' |
||||
|
|
||||
|
רק **פייתון 3.6+** סטנדרטי. |
||||
|
|
||||
|
לדוגמא, ל - `int`: |
||||
|
|
||||
|
```Python |
||||
|
item_id: int |
||||
|
``` |
||||
|
|
||||
|
או למודל `Item` מורכב יותר: |
||||
|
|
||||
|
```Python |
||||
|
item: Item |
||||
|
``` |
||||
|
|
||||
|
...ועם הכרזת הטיפוס האחת הזו אתם מקבלים: |
||||
|
|
||||
|
- תמיכת עורך, כולל: |
||||
|
- השלמות. |
||||
|
- בדיקת טיפוסים. |
||||
|
- אימות מידע: |
||||
|
- שגיאות ברורות ואטומטיות כאשר מוכנס מידע לא חוקי . |
||||
|
- אימות אפילו לאובייקטי JSON מקוננים. |
||||
|
- <abbr title="ידועה גם כ: פרסור, סיריאליזציה">המרה</abbr> של מידע קלט: המרה של מידע שמגיע מהרשת למידע וטיפוסים של פייתון. קורא מ: |
||||
|
- JSON. |
||||
|
- פרמטרי נתיב. |
||||
|
- פרמטרי שאילתא. |
||||
|
- עוגיות. |
||||
|
- כותרות. |
||||
|
- טפסים. |
||||
|
- קבצים. |
||||
|
- <abbr title="ידועה גם כ: פרסור, סיריאליזציה">המרה</abbr> של מידע פלט: המרה של מידע וטיפוסים מפייתון למידע רשת (כ - JSON): |
||||
|
- המירו טיפוסי פייתון (`str`, `int`, `float`, `bool`, `list`, etc). |
||||
|
- עצמי `datetime`. |
||||
|
- עצמי `UUID`. |
||||
|
- מודלי בסיסי נתונים. |
||||
|
- ...ורבים אחרים. |
||||
|
- תיעוד API אוטומטי ואינטרקטיבית כולל שתי אלטרנטיבות לממשק המשתמש: |
||||
|
- Swagger UI. |
||||
|
- ReDoc. |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
בחזרה לדוגמאת הקוד הקודמת, **FastAPI** ידאג: |
||||
|
|
||||
|
- לאמת שיש `item_id` בנתיב בבקשות `GET` ו - `PUT`. |
||||
|
- לאמת שה - `item_id` הוא מטיפוס `int` בבקשות `GET` ו - `PUT`. |
||||
|
- אם הוא לא, הלקוח יראה שגיאה ברורה ושימושית. |
||||
|
- לבדוק האם קיים פרמטר שאילתא בשם `q` (קרי `http://127.0.0.1:8000/items/foo?q=somequery`) לבקשות `GET`. |
||||
|
- מאחר והפרמטר `q` מוגדר עם <code dir="ltr"> = None</code>, הוא אופציונלי. |
||||
|
- לולא ה - `None` הוא היה חובה (כמו הגוף במקרה של `PUT`). |
||||
|
- לבקשות `PUT` לנתיב <code dir="ltr">/items/{item_id}</code>, לקרוא את גוף הבקשה כ - JSON: |
||||
|
- לאמת שהוא כולל את מאפיין החובה `name` שאמור להיות מטיפוס `str`. |
||||
|
- לאמת שהוא כולל את מאפיין החובה `price` שחייב להיות מטיפוס `float`. |
||||
|
- לבדוק האם הוא כולל את מאפיין הרשות `is_offer` שאמור להיות מטיפוס `bool`, אם הוא נמצא. |
||||
|
- כל זה יעבוד גם לאובייקט JSON מקונן. |
||||
|
- להמיר מ - JSON ול- JSON אוטומטית. |
||||
|
- לתעד הכל באמצעות OpenAPI, תיעוד שבו יוכלו להשתמש: |
||||
|
- מערכות תיעוד אינטרקטיביות. |
||||
|
- מערכות ייצור קוד אוטומטיות, להרבה שפות. |
||||
|
- לספק ישירות שתי מערכות תיעוד רשתיות. |
||||
|
|
||||
|
--- |
||||
|
|
||||
|
רק גרדנו את קצה הקרחון, אבל כבר יש לכם רעיון של איך הכל עובד. |
||||
|
|
||||
|
נסו לשנות את השורה: |
||||
|
|
||||
|
```Python |
||||
|
return {"item_name": item.name, "item_id": item_id} |
||||
|
``` |
||||
|
|
||||
|
...מ: |
||||
|
|
||||
|
```Python |
||||
|
... "item_name": item.name ... |
||||
|
``` |
||||
|
|
||||
|
...ל: |
||||
|
|
||||
|
```Python |
||||
|
... "item_price": item.price ... |
||||
|
``` |
||||
|
|
||||
|
...וראו איך העורך שלכם משלים את המאפיינים ויודע את הטיפוסים שלהם: |
||||
|
|
||||
|
 |
||||
|
|
||||
|
לדוגמא יותר שלמה שכוללת עוד תכונות, ראו את ה<a href="https://fastapi.tiangolo.com/tutorial/">מדריך - למשתמש</a>. |
||||
|
|
||||
|
**התראת ספוילרים**: המדריך - למשתמש כולל: |
||||
|
|
||||
|
- הכרזה על **פרמטרים** ממקורות אחרים ושונים כגון: **כותרות**, **עוגיות**, **טפסים** ו - **קבצים**. |
||||
|
- איך לקבוע **מגבלות אימות** בעזרת `maximum_length` או `regex`. |
||||
|
- דרך חזקה וקלה להשתמש ב**<abbr title="ידועה גם כרכיבים, משאבים, ספקים, שירותים, מוזרקים">הזרקת תלויות</abbr>**. |
||||
|
- אבטחה והתאמתות, כולל תמיכה ב - **OAuth2** עם **JWT** והתאמתות **HTTP Basic**. |
||||
|
- טכניקות מתקדמות (אבל קלות באותה מידה) להכרזת אובייקטי JSON מקוננים (תודות ל - Pydantic). |
||||
|
- אינטרקציה עם **GraphQL** דרך <a href="https://strawberry.rocks" class="external-link" target="_blank">Strawberry</a> וספריות אחרות. |
||||
|
- תכונות נוספות רבות (תודות ל - Starlette) כגון: |
||||
|
- **WebSockets** |
||||
|
- בדיקות קלות במיוחד מבוססות על `requests` ו - `pytest` |
||||
|
- **CORS** |
||||
|
- **Cookie Sessions** |
||||
|
- ...ועוד. |
||||
|
|
||||
|
## ביצועים |
||||
|
|
||||
|
בדיקות עצמאיות של TechEmpower הראו שאפליקציות **FastAPI** שרצות תחת Uvicorn הן <a href="https://www.techempower.com/benchmarks/#section=test&runid=7464e520-0dc2-473d-bd34-dbdfd7e85911&hw=ph&test=query&l=zijzen-7" class="external-link" target="_blank">מתשתיות הפייתון המהירות ביותר</a>, רק מתחת ל - Starlette ו - Uvicorn עצמן (ש - FastAPI מבוססת עליהן). (\*) |
||||
|
|
||||
|
כדי להבין עוד על הנושא, ראו את הפרק <a href="https://fastapi.tiangolo.com/benchmarks/" class="internal-link" target="_blank">Benchmarks</a>. |
||||
|
|
||||
|
## תלויות אופציונליות |
||||
|
|
||||
|
בשימוש Pydantic: |
||||
|
|
||||
|
- <a href="https://github.com/esnme/ultrajson" target="_blank"><code>ujson</code></a> - <abbr title="המרת המחרוזת שמגיעה מבקשת HTTP למידע פייתון">"פרסור"</abbr> JSON. |
||||
|
- <a href="https://github.com/JoshData/python-email-validator" target="_blank"><code>email_validator</code></a> - לאימות כתובות אימייל. |
||||
|
|
||||
|
בשימוש Starlette: |
||||
|
|
||||
|
- <a href="https://requests.readthedocs.io" target="_blank"><code>requests</code></a> - דרוש אם ברצונכם להשתמש ב - `TestClient`. |
||||
|
- <a href="https://jinja.palletsprojects.com" target="_blank"><code>jinja2</code></a> - דרוש אם ברצונכם להשתמש בברירת המחדל של תצורת הטמפלייטים. |
||||
|
- <a href="https://andrew-d.github.io/python-multipart/" target="_blank"><code>python-multipart</code></a> - דרוש אם ברצונכם לתמוך ב <abbr title="המרת המחרוזת שמגיעה מבקשת HTTP למידע פייתון">"פרסור"</abbr> טפסים, באצמעות <code dir="ltr">request.form()</code>. |
||||
|
- <a href="https://pythonhosted.org/itsdangerous/" target="_blank"><code>itsdangerous</code></a> - דרוש אם ברצונכם להשתמש ב - `SessionMiddleware`. |
||||
|
- <a href="https://pyyaml.org/wiki/PyYAMLDocumentation" target="_blank"><code>pyyaml</code></a> - דרוש אם ברצונכם להשתמש ב - `SchemaGenerator` של Starlette (כנראה שאתם לא צריכים את זה עם FastAPI). |
||||
|
- <a href="https://github.com/esnme/ultrajson" target="_blank"><code>ujson</code></a> - דרוש אם ברצונכם להשתמש ב - `UJSONResponse`. |
||||
|
|
||||
|
בשימוש FastAPI / Starlette: |
||||
|
|
||||
|
- <a href="https://www.uvicorn.org" target="_blank"><code>uvicorn</code></a> - לשרת שטוען ומגיש את האפליקציה שלכם. |
||||
|
- <a href="https://github.com/ijl/orjson" target="_blank"><code>orjson</code></a> - דרוש אם ברצונכם להשתמש ב - `ORJSONResponse`. |
||||
|
|
||||
|
תוכלו להתקין את כל אלו באמצעות <code dir="ltr">pip install "fastapi[all]"</code>. |
||||
|
|
||||
|
## רשיון |
||||
|
|
||||
|
הפרויקט הזה הוא תחת התנאים של רשיון MIT. |
||||
@ -0,0 +1,140 @@ |
|||||
|
site_name: FastAPI |
||||
|
site_description: FastAPI framework, high performance, easy to learn, fast to code, ready for production |
||||
|
site_url: https://fastapi.tiangolo.com/he/ |
||||
|
theme: |
||||
|
name: material |
||||
|
custom_dir: overrides |
||||
|
palette: |
||||
|
- media: '(prefers-color-scheme: light)' |
||||
|
scheme: default |
||||
|
primary: teal |
||||
|
accent: amber |
||||
|
toggle: |
||||
|
icon: material/lightbulb |
||||
|
name: Switch to light mode |
||||
|
- media: '(prefers-color-scheme: dark)' |
||||
|
scheme: slate |
||||
|
primary: teal |
||||
|
accent: amber |
||||
|
toggle: |
||||
|
icon: material/lightbulb-outline |
||||
|
name: Switch to dark mode |
||||
|
features: |
||||
|
- search.suggest |
||||
|
- search.highlight |
||||
|
- content.tabs.link |
||||
|
icon: |
||||
|
repo: fontawesome/brands/github-alt |
||||
|
logo: https://fastapi.tiangolo.com/img/icon-white.svg |
||||
|
favicon: https://fastapi.tiangolo.com/img/favicon.png |
||||
|
language: he |
||||
|
repo_name: tiangolo/fastapi |
||||
|
repo_url: https://github.com/tiangolo/fastapi |
||||
|
edit_uri: '' |
||||
|
plugins: |
||||
|
- search |
||||
|
- markdownextradata: |
||||
|
data: data |
||||
|
nav: |
||||
|
- FastAPI: index.md |
||||
|
- Languages: |
||||
|
- en: / |
||||
|
- az: /az/ |
||||
|
- de: /de/ |
||||
|
- es: /es/ |
||||
|
- fa: /fa/ |
||||
|
- fr: /fr/ |
||||
|
- he: /he/ |
||||
|
- id: /id/ |
||||
|
- it: /it/ |
||||
|
- ja: /ja/ |
||||
|
- ko: /ko/ |
||||
|
- nl: /nl/ |
||||
|
- pl: /pl/ |
||||
|
- pt: /pt/ |
||||
|
- ru: /ru/ |
||||
|
- sq: /sq/ |
||||
|
- tr: /tr/ |
||||
|
- uk: /uk/ |
||||
|
- zh: /zh/ |
||||
|
markdown_extensions: |
||||
|
- toc: |
||||
|
permalink: true |
||||
|
- markdown.extensions.codehilite: |
||||
|
guess_lang: false |
||||
|
- mdx_include: |
||||
|
base_path: docs |
||||
|
- admonition |
||||
|
- codehilite |
||||
|
- extra |
||||
|
- pymdownx.superfences: |
||||
|
custom_fences: |
||||
|
- name: mermaid |
||||
|
class: mermaid |
||||
|
format: !!python/name:pymdownx.superfences.fence_code_format '' |
||||
|
- pymdownx.tabbed: |
||||
|
alternate_style: true |
||||
|
extra: |
||||
|
analytics: |
||||
|
provider: google |
||||
|
property: UA-133183413-1 |
||||
|
social: |
||||
|
- icon: fontawesome/brands/github-alt |
||||
|
link: https://github.com/tiangolo/fastapi |
||||
|
- icon: fontawesome/brands/discord |
||||
|
link: https://discord.gg/VQjSZaeJmf |
||||
|
- icon: fontawesome/brands/twitter |
||||
|
link: https://twitter.com/fastapi |
||||
|
- icon: fontawesome/brands/linkedin |
||||
|
link: https://www.linkedin.com/in/tiangolo |
||||
|
- icon: fontawesome/brands/dev |
||||
|
link: https://dev.to/tiangolo |
||||
|
- icon: fontawesome/brands/medium |
||||
|
link: https://medium.com/@tiangolo |
||||
|
- icon: fontawesome/solid/globe |
||||
|
link: https://tiangolo.com |
||||
|
alternate: |
||||
|
- link: / |
||||
|
name: en - English |
||||
|
- link: /az/ |
||||
|
name: az |
||||
|
- link: /de/ |
||||
|
name: de |
||||
|
- link: /es/ |
||||
|
name: es - español |
||||
|
- link: /fa/ |
||||
|
name: fa |
||||
|
- link: /fr/ |
||||
|
name: fr - français |
||||
|
- link: /he/ |
||||
|
name: he |
||||
|
- link: /id/ |
||||
|
name: id |
||||
|
- link: /it/ |
||||
|
name: it - italiano |
||||
|
- link: /ja/ |
||||
|
name: ja - 日本語 |
||||
|
- link: /ko/ |
||||
|
name: ko - 한국어 |
||||
|
- link: /nl/ |
||||
|
name: nl |
||||
|
- link: /pl/ |
||||
|
name: pl |
||||
|
- link: /pt/ |
||||
|
name: pt - português |
||||
|
- link: /ru/ |
||||
|
name: ru - русский язык |
||||
|
- link: /sq/ |
||||
|
name: sq - shqip |
||||
|
- link: /tr/ |
||||
|
name: tr - Türkçe |
||||
|
- link: /uk/ |
||||
|
name: uk - українська мова |
||||
|
- link: /zh/ |
||||
|
name: zh - 汉语 |
||||
|
extra_css: |
||||
|
- https://fastapi.tiangolo.com/css/termynal.css |
||||
|
- https://fastapi.tiangolo.com/css/custom.css |
||||
|
extra_javascript: |
||||
|
- https://fastapi.tiangolo.com/js/termynal.js |
||||
|
- https://fastapi.tiangolo.com/js/custom.js |
||||
@ -0,0 +1,58 @@ |
|||||
|
# 条件付き OpenAPI |
||||
|
|
||||
|
必要であれば、設定と環境変数を利用して、環境に応じて条件付きでOpenAPIを構成することが可能です。また、完全にOpenAPIを無効にすることもできます。 |
||||
|
|
||||
|
## セキュリティとAPI、およびドキュメントについて |
||||
|
|
||||
|
本番環境においてドキュメントのUIを非表示にすることによって、APIを保護しようと *すべきではありません*。 |
||||
|
|
||||
|
それは、APIのセキュリティの強化にはならず、*path operations* は依然として利用可能です。 |
||||
|
|
||||
|
もしセキュリティ上の欠陥がソースコードにあるならば、それは存在したままです。 |
||||
|
|
||||
|
ドキュメンテーションを非表示にするのは、単にあなたのAPIへのアクセス方法を難解にするだけでなく、同時にあなた自身の本番環境でのAPIのデバッグを困難にしてしまう可能性があります。単純に、 <a href="https://en.wikipedia.org/wiki/Security_through_obscurity" class="external-link" target="_blank">Security through obscurity</a> の一つの形態として考えられるでしょう。 |
||||
|
|
||||
|
もしあなたのAPIのセキュリティを強化したいなら、いくつかのよりよい方法があります。例を示すと、 |
||||
|
|
||||
|
* リクエストボディとレスポンスのためのPydanticモデルの定義を見直す。 |
||||
|
* 依存関係に基づきすべての必要なパーミッションとロールを設定する。 |
||||
|
* パスワードを絶対に平文で保存しない。パスワードハッシュのみを保存する。 |
||||
|
* PasslibやJWTトークンに代表される、よく知られた暗号化ツールを使って実装する。 |
||||
|
* そして必要なところでは、もっと細かいパーミッション制御をOAuth2スコープを使って行う。 |
||||
|
* など |
||||
|
|
||||
|
それでも、例えば本番環境のような特定の環境のみで、あるいは環境変数の設定によってAPIドキュメントをどうしても無効にしたいという、非常に特殊なユースケースがあるかもしれません。 |
||||
|
|
||||
|
## 設定と環境変数による条件付き OpenAPI |
||||
|
|
||||
|
生成するOpenAPIとドキュメントUIの構成は、共通のPydanticの設定を使用して簡単に切り替えられます。 |
||||
|
|
||||
|
例えば、 |
||||
|
|
||||
|
```Python hl_lines="6 11" |
||||
|
{!../../../docs_src/conditional_openapi/tutorial001.py!} |
||||
|
``` |
||||
|
|
||||
|
ここでは `openapi_url` の設定を、デフォルトの `"/openapi.json"` のまま宣言しています。 |
||||
|
|
||||
|
そして、これを `FastAPI` appを作る際に使います。 |
||||
|
|
||||
|
それから、以下のように `OPENAPI_URL` という環境変数を空文字列に設定することによってOpenAPI (UIドキュメントを含む) を無効化することができます。 |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ OPENAPI_URL= uvicorn main:app |
||||
|
|
||||
|
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
すると、以下のように `/openapi.json`, `/docs`, `/redoc` のどのURLにアクセスしても、 `404 Not Found` エラーが返ってくるようになります。 |
||||
|
|
||||
|
```JSON |
||||
|
{ |
||||
|
"detail": "Not Found" |
||||
|
} |
||||
|
``` |
||||
@ -0,0 +1,24 @@ |
|||||
|
# ユーザーガイド 応用編 |
||||
|
|
||||
|
## さらなる機能 |
||||
|
|
||||
|
[チュートリアル - ユーザーガイド](../tutorial/){.internal-link target=_blank}により、**FastAPI**の主要な機能は十分に理解できたことでしょう。 |
||||
|
|
||||
|
以降のセクションでは、チュートリアルでは説明しきれなかったオプションや設定、および機能について説明します。 |
||||
|
|
||||
|
!!! tip "豆知識" |
||||
|
以降のセクションは、 **必ずしも"応用編"ではありません**。 |
||||
|
|
||||
|
ユースケースによっては、その中から解決策を見つけられるかもしれません。 |
||||
|
|
||||
|
## 先にチュートリアルを読む |
||||
|
|
||||
|
[チュートリアル - ユーザーガイド](../tutorial/){.internal-link target=_blank}の知識があれば、**FastAPI**の主要な機能を利用することができます。 |
||||
|
|
||||
|
以降のセクションは、すでにチュートリアルを読んで、その主要なアイデアを理解できていることを前提としています。 |
||||
|
|
||||
|
## テスト駆動開発のコース |
||||
|
|
||||
|
このセクションの内容を補完するために脱初心者用コースを受けたい場合は、**TestDriven.io**による、<a href="https://testdriven.io/courses/tdd-fastapi/" class="external-link" target="_blank">Test-Driven Development with FastAPI and Docker</a>を確認するのがよいかもしれません。 |
||||
|
|
||||
|
現在、このコースで得られた利益の10%が**FastAPI**の開発のために寄付されています。🎉 😄 |
||||
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue