FastAPI یک وب فریم‌ورک مدرن و سریع (با کارایی بالا) برای ایجاد APIهای متنوع (وب، وب‌سوکت و غبره) با زبان پایتون نسخه +۳.۶ است. این فریم‌ورک با رعایت کامل راهنمای نوع داده (Type Hint) ایجاد شده است.
FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.
ویژگی‌های کلیدی این فریم‌ورک عبارتند از:
The key features are:
* **<abbrtitle="Fast">سرعت</abbr>**: کارایی بسیار بالا و قابل مقایسه با **NodeJS** و **Go** (با تشکر از Starlette و Pydantic). [یکی از سریع‌ترین فریم‌ورک‌های پایتونی موجود](#performance).
* **Fast**: Very high performance, on par with **NodeJS** and **Go** (thanks to Starlette and Pydantic). [One of the fastest Python frameworks available](#performance).
* **<abbrtitle="Fast to code">کدنویسی سریع</abbr>**: افزایش ۲۰۰ تا ۳۰۰ درصدی سرعت توسعه فابلیت‌های جدید. *
* **<abbrtitle="Intuitive">غریزی</abbr>**: پشتیبانی فوق‌العاده در محیط‌های توسعه یکپارچه (IDE). <abbrtitle="یا اتوکامپلیت، اتوکامپلشن، اینتلیسنس">تکمیل</abbr> در همه بخش‌های کد. کاهش زمان رفع باگ.
* **<abbrtitle="Easy">آسان</abbr>**: طراحی شده برای یادگیری و استفاده آسان. کاهش زمان مورد نیاز برای مراجعه به مستندات.
* **<abbrtitle="Short">کوچک</abbr>**: کاهش تکرار در کد. چندین قابلیت برای هر پارامتر (منظور پارامترهای ورودی تابع هندلر می‌باشد، به بخش <ahref="https://fastapi.tiangolo.com/#recap">خلاصه</a> در همین صفحه مراجعه شود). باگ کمتر.
* **<abbrtitle="Robust">استوار</abbr>**: ایجاد کدی آماده برای استفاده در محیط پروداکشن و تولید خودکار <abbrtitle="Interactive documentation">مستندات تعاملی</abbr>
* **<abbrtitle="Standards-based">مبتنی بر استانداردها</abbr>**: مبتنی بر (و منطبق با) استانداردهای متن باز مربوط به API: <ahref="https://github.com/OAI/OpenAPI-Specification"class="external-link"target="_blank">OpenAPI</a> (سوگر سابق) و <ahref="https://json-schema.org/"class="external-link"target="_blank">JSON Schema</a>.
* **Fast to code**: Increase the speed to develop features by about 200% to 300%. *
<small>* تخمین‌ها بر اساس تست‌های انجام شده در یک تیم توسعه داخلی که مشغول ایجاد برنامه‌های کاربردی واقعی بودند صورت گرفته است.</small>
* **Fewer bugs**: Reduce about 40% of human (developer) induced errors. *
* **Intuitive**: Great editor support. <abbrtitle="also known as auto-complete, autocompletion, IntelliSense">Completion</abbr> 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: <ahref="https://github.com/OAI/OpenAPI-Specification"class="external-link"target="_blank">OpenAPI</a> (previously known as Swagger) and <ahref="https://json-schema.org/"class="external-link"target="_blank">JSON Schema</a>.
<small>* estimation based on tests on an internal development team, building production applications.</small>
"_[...] 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._"
<divstyle="text-align: left; direction: ltr;"><em> [...] I'm using <strong>FastAPI</strong> a ton these days. [...] I'm actually planning to use it for all of my team's <strong>ML services at Microsoft</strong>. Some of them are getting integrated into the core <strong>Windows</strong> product and some <strong>Office</strong> products."</em></div>
"_We adopted the **FastAPI** library to spawn a **REST** server that can be queried to obtain **predictions**. [for Ludwig]_"
<divstyle="text-align: left; direction: ltr;"><em>"We adopted the <strong>FastAPI</strong> library to spawn a <strong>REST</strong>server that can be queried to obtain <strong>predictions</strong>. [for Ludwig]"</em></div>
<divstyle="text-align: right; margin-right: 10%;">Piero Molino, Yaroslav Dudin, and Sai Sumanth Miryala - <strong>Uber</strong><ahref="https://eng.uber.com/ludwig-v0-2/"target="_blank"><small>(ref)</small></a></div>
<divstyle="text-align: right; margin-right: 10%;">Piero Molino, Yaroslav Dudin, and Sai Sumanth Miryala - <strong>Uber</strong><ahref="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**]_"
<divstyle="text-align: left; direction: ltr;">"<strong>Netflix</strong> is pleased to announce the open-source release of our <strong>crisis management</strong> orchestration framework: <strong>Dispatch</strong>! [built with <strong>FastAPI</strong>]"</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._"
<divstyle="text-align: left; direction: ltr;">"<em>Honestly, what you've built looks super solid and polished. In many ways, it's what I wanted <strong>Hug</strong> to be - it's really inspiring to see someone build that."</em></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 [...]_"
<divstyle="text-align: left; direction: ltr;">"<em>If you're looking to learn one <strong>modern framework</strong> for building REST APIs, check out <strong>FastAPI</strong> [...] It's fast, easy to use and easy to learn [...]"</em></div>
"_We've switched over to **FastAPI** for our **APIs** [...] I think you'll like it [...]_"
<divstyle="text-align: left; direction: ltr;">"<em>We've switched over to <strong>FastAPI</strong> for our <strong>APIs</strong> [...] I think you'll like it [...]</em>"</div>
If you are building a<abbrtitle="Command Line Interface">CLI</abbr>app to be used in the terminal instead of a web API, check out<ahref="https://typer.tiangolo.com/"class="external-link"target="_blank">**Typer**</a>.
اگر در حال ساختن برنامه‌ای برای استفاده در<abbrtitle="Command Line Interface">CLI</abbr>(به جای استفاده در وب) هستید، می‌توانید از<ahref="https://typer.tiangolo.com/"class="external-link"target="_blank">**Typer**</a>. استفاده کنید.
**Typer** is FastAPI's little sibling. And it's intended to be the **FastAPI of CLIs**. ⌨️ 🚀
**Typer** دوقلوی کوچکتر FastAPI است و قرار است معادلی برای FastAPI در برنامه‌های CLI باشد.️ 🚀
## Requirements
## نیازمندی‌ها
Python 3.6+
پایتون +۳.۶
FastAPI stands on the shoulders of giants:
FastAPI مبتنی بر ابزارهای قدرتمند زیر است:
* <ahref="https://www.starlette.io/"class="external-link"target="_blank">Starlette</a>for the web parts.
* فریم‌ورک <ahref="https://www.starlette.io/"class="external-link"target="_blank">Starlette</a>برای بخش وب.
* <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a>for the data parts.
* کتابخانه <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a>برای بخش داده.
## Installation
## نصب
<divclass="termy">
<divclass="termy">
@ -133,7 +125,7 @@ $ pip install fastapi
</div>
</div>
You will also need an ASGI server, for production such as<ahref="https://www.uvicorn.org"class="external-link"target="_blank">Uvicorn</a>or<ahref="https://gitlab.com/pgjones/hypercorn"class="external-link"target="_blank">Hypercorn</a>.
نصب یک سرور پروداکشن نظیر<ahref="https://www.uvicorn.org"class="external-link"target="_blank">Uvicorn</a>یا<ahref="https://gitlab.com/pgjones/hypercorn"class="external-link"target="_blank">Hypercorn</a> نیز جزء نیازمندی‌هاست.
اگر با `async / await` آشنا نیستید، به بخش _"عجله دارید?"_ در صفحه درباره <ahref="https://fastapi.tiangolo.com/async/#in-a-hurry"target="_blank">`async` و `await` در مستندات</a> مراجعه کنید.
If you don't know, check the _"In a hurry?"_ section about <ahref="https://fastapi.tiangolo.com/async/#in-a-hurry"target="_blank">`async` and `await` in the docs</a>.
* `main`: the file `main.py` (the Python "module").
* `main`: فایل `main.py` (ماژول پایتون ایجاد شده).
* `app`: the object created inside of `main.py` with the line`app = FastAPI()`.
* `app`: شیء ایجاد شده در فایل `main.py` در خط`app = FastAPI()`.
* `--reload`: make the server restart after code changes. Only do this for development.
* `--reload`: ریستارت کردن سرور با تغییر کد. تنها در هنگام توسعه از این گزینه استفاده شود..
</details>
</details>
### Check it
### بررسی کنید
Open your browser at<ahref="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>.
آدرس<ahref="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> را در مرورگر خود باز کنید.
You will see the JSON response as:
پاسخ JSON زیر را مشاهده خواهید کرد:
```JSON
```JSON
{"item_id": 5, "q": "somequery"}
{"item_id": 5, "q": "somequery"}
```
```
You already created an API that:
تا اینجا شما APIای ساختید که:
* Receives HTTP requests in the _paths_`/` and `/items/{item_id}`.
* درخواست‌های HTTP به _مسیرهای_`/` و `/items/{item_id}` را دریافت می‌کند.
* Both _paths_ take `GET`<em>operations</em> (also known as HTTP _methods_).
* هردو _مسیر_<abbrtitle="operations در OpenAPI">عملیات</abbr> (یا HTTP _متد_) `GET` را پشتیبانی می‌کنند.
* The _path_`/items/{item_id}` has a _path parameter_`item_id` that should be an `int`.
* _مسیر_`/items/{item_id}` شامل <abbrtitle="Path Parameter">_پارامتر مسیر_</abbr>`item_id` از نوع `int` است.
* The _path_`/items/{item_id}` has an optional `str`_query parameter_`q`.
* _مسیر_`/items/{item_id}` شامل <abbrtitle="Query Parameter">_پارامتر پرسمان_</abbr> اختیاری `q` از نوع `str` است.
### Interactive API docs
### مستندات API تعاملی
Now go to<ahref="http://127.0.0.1:8000/docs"class="external-link"target="_blank">http://127.0.0.1:8000/docs</a>.
حال به آدرس <ahref="http://127.0.0.1:8000/docs"class="external-link"target="_blank">http://127.0.0.1:8000/docs</a> بروید.
You will see the automatic interactive API documentation (provided by<ahref="https://github.com/swagger-api/swagger-ui"class="external-link"target="_blank">Swagger UI</a>):
مستندات API تعاملی (ایجاد شده به کمک<ahref="https://github.com/swagger-api/swagger-ui"class="external-link"target="_blank">Swagger UI</a>) را مشاهده خواهید کرد:
And now, go to<ahref="http://127.0.0.1:8000/redoc"class="external-link"target="_blank">http://127.0.0.1:8000/redoc</a>.
حال به آدرس <ahref="http://127.0.0.1:8000/redoc"class="external-link"target="_blank">http://127.0.0.1:8000/redoc</a> بروید.
You will see the alternative automatic documentation (provided by<ahref="https://github.com/Rebilly/ReDoc"class="external-link"target="_blank">ReDoc</a>):
مستندات خودکار دیگری را مشاهده خواهید کرد که به کمک<ahref="https://github.com/Rebilly/ReDoc"class="external-link"target="_blank">ReDoc</a> ایجاد می‌شود:
* Then click on the "Execute" button, the user interface will communicate with your API, send the parameters, get the results and show them on the screen:
* سپس روی دکمه "Execute" کلیک کنید, خواهید دید که واسط کاریری با APIهای تعریف شده ارتباط برقرار کرده، پارامترهای مورد نیاز را به آنها ارسال می‌کند، سپس نتایج را دریافت کرده و در صفحه نشان می‌دهد:
In summary, you declare **once** the types of parameters, body, etc. as function parameters.
به طور خلاصه شما **یک بار** انواع پارامترها، بدنه و غیره را به عنوان پارامترهای ورودی تابع خود تعریف می‌کنید.
You do that with standard modern Python types.
این کار را با استفاده از انواع استاندارد و مدرن موجود در پایتون انجام می‌دهید.
You don't have to learn a new syntax, the methods or classes of a specific library, etc.
نیازی به یادگیری <abbrtitle="Syntax">نحو</abbr> جدید یا متدها و کلاس‌های یک کتابخانه بخصوص و غیره نیست.
Just standard **Python 3.6+**.
تنها **پایتون +۳.۶**.
For example, for an`int`:
به عنوان مثال برای یک پارامتر از نوع`int`:
```Python
```Python
item_id: int
item_id: int
```
```
or for a more complex `Item` model:
یا برای یک مدل پیچیده‌تر مثل `Item`:
```Python
```Python
item: Item
item: Item
```
```
...and with that single declaration you get:
...و با همین اعلان تمامی قابلیت‌های زیر در دسترس قرار می‌گیرد:
* Editor support, including:
* پشتیبانی ویرایشگر متنی شامل:
* Completion.
* تکمیل کد.
* Type checks.
* بررسی انواع داده.
* Validation of data:
* اعتبارسنجی داده:
* Automatic and clear errors when the data is invalid.
* خطاهای خودکار و مشخص در هنگام نامعتبر بودن داده
* Validation even for deeply nested JSON objects.
* اعتبارسنجی، حتی برای اشیاء JSON تو در تو.
* <abbrtitle="also known as: serialization, parsing, marshalling">Conversion</abbr>of input data: coming from the network to Python data and types. Reading from:
* <abbrtitle="serialization, parsing, marshalling">تبدیل</abbr>داده ورودی: که از شبکه رسیده به انواع و داده پایتونی. این داده شامل:
* <abbrtitle="also known as: serialization, parsing, marshalling">Conversion</abbr>of output data: converting from Python data and types to network data (as JSON):
* <abbrtitle="serialization, parsing, marshalling">تبدیل</abbr>داده خروجی: تبدیل از انواع و داده پایتون به داده شبکه (مانند JSON):
For a more complete example including more features, see the<ahref="https://fastapi.tiangolo.com/tutorial/">Tutorial - User Guide</a>.
برای مشاهده مثال‌های کامل‌تر که شامل قابلیت‌های بیشتری از FastAPI باشد به بخش<ahref="https://fastapi.tiangolo.com/tutorial/">آموزش - راهنمای کاربر</a> مراجعه کنید.
**Spoiler alert**: the tutorial - user guide includes:
**هشدار اسپویل**: بخش آموزش - راهنمای کاربر شامل موارد زیر است:
* Declaration of **parameters** from other different places as: **headers**, **cookies**, **form fields** and **files**.
* اعلان **پارامترهای** موجود در بخش‌های دیگر درخواست، شامل: **سرآیند (هدر)ها**, **کوکی‌ها**, **فیلد‌های فرم** و **فایل‌ها**.
* How to set **validation constraints** as `maximum_length` or`regex`.
* چگونگی تنظیم **<abbrtitle="Validation Constraints">محدودیت‌های اعتبارسنجی</abbr>** به عنوان مثال `maximum_length` یا`regex`.
* A very powerful and easy to use**<abbrtitle="also known as components, resources, providers, services, injectables">Dependency Injection</abbr>** system.
* سیستم**<abbrtitle="also known as components, resources, providers, services, injectables">Dependency Injection</abbr>** قوی و کاربردی.
* Security and authentication, including support for **OAuth2** with **JWT tokens** and **HTTP Basic** auth.
* امنیت و تایید هویت, شامل پشتیبانی از **OAuth2** مبتنی بر **JWT tokens** و **HTTP Basic**.
* More advanced (but equally easy) techniques for declaring **deeply nested JSON models** (thanks to Pydantic).
* تکنیک پیشرفته برای تعریف **مدل‌های چند سطحی JSON** (بر اساس Pydantic).
* **GraphQL** integration with <ahref="https://strawberry.rocks"class="external-link"target="_blank">Strawberry</a> and other libraries.
* قابلیت‌های اضافی دیگر (بر اساس Starlette) شامل:
* Many extra features (thanks to Starlette) as:
* **<abbrtitle="WebSocket">وب‌سوکت</abbr>**
* **WebSockets**
* **GraphQL**
* extremely easy tests based on `requests` and`pytest`
* تست‌های خودکار آسان مبتنی بر `requests` و`pytest`
* **CORS**
* **CORS**
* **Cookie Sessions**
* **Cookie Sessions**
* ...and more.
* و موارد بیشمار دیگر.
## Performance
## کارایی
Independent TechEmpower benchmarks show **FastAPI** applications running under Uvicorn as<ahref="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">one of the fastest Python frameworks available</a>, only below Starlette and Uvicorn themselves (used internally by FastAPI). (*)
معیار (بنچمارک)های مستقل TechEmpower حاکی از آن است که برنامه‌های **FastAPI** که تحت Uvicorn اجرا می‌شود،<ahref="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 بر اساس آنها ایجاد شده است) (*)
To understand more about it, see the section<ahref="https://fastapi.tiangolo.com/benchmarks/"class="internal-link"target="_blank">Benchmarks</a>.
برای درک بهتری از این موضوع به بخش<ahref="https://fastapi.tiangolo.com/benchmarks/"class="internal-link"target="_blank">بنچ‌مارک‌ها</a> مراجعه کنید.
## Optional Dependencies
## نیازمندی‌های اختیاری
Used by Pydantic:
استفاده شده توسط Pydantic:
* <ahref="https://github.com/esnme/ultrajson"target="_blank"><code>ujson</code></a> - for faster JSON<abbrtitle="converting the string that comes from an HTTP request into Python data">"parsing"</abbr>.
* <ahref="https://github.com/esnme/ultrajson"target="_blank"><code>ujson</code></a> - برای<abbrtitle="تبدیل داده‌های موجود در درخواست‌های HTTP به داده پایتونی">"تجزیه (parse)"</abbr> سریع‌تر JSON .
* <ahref="https://github.com/JoshData/python-email-validator"target="_blank"><code>email_validator</code></a> - for email validation.
* <ahref="https://github.com/JoshData/python-email-validator"target="_blank"><code>email_validator</code></a> - برای اعتبارسنجی آدرس‌های ایمیل.
Used by Starlette:
استفاده شده توسط Starlette:
* <ahref="https://requests.readthedocs.io"target="_blank"><code>requests</code></a> - Required if you want to use the `TestClient`.
* <ahref="https://requests.readthedocs.io"target="_blank"><code>requests</code></a> - در صورتی که می‌خواهید از `TestClient` استفاده کنید.
* <ahref="https://jinja.palletsprojects.com"target="_blank"><code>jinja2</code></a> - Required if you want to use the default template configuration.
* <ahref="https://github.com/Tinche/aiofiles"target="_blank"><code>aiofiles</code></a> - در صورتی که می‌خواهید از `FileResponse` و `StaticFiles` استفاده کنید.
* <ahref="https://andrew-d.github.io/python-multipart/"target="_blank"><code>python-multipart</code></a> - Required if you want to support form <abbrtitle="converting the string that comes from an HTTP request into Python data">"parsing"</abbr>, with `request.form()`.
* <ahref="https://jinja.palletsprojects.com"target="_blank"><code>jinja2</code></a> - در صورتی که بخواهید از پیکربندی پیش‌فرض برای قالب‌ها استفاده کنید.
* <ahref="https://pythonhosted.org/itsdangerous/"target="_blank"><code>itsdangerous</code></a> - Required for `SessionMiddleware` support.
* <ahref="https://andrew-d.github.io/python-multipart/"target="_blank"><code>python-multipart</code></a> - در صورتی که بخواهید با استفاده از `request.form()` از قابلیت <abbrtitle="تبدیل رشته متنی موجود در درخواست HTTP به انواع داده پایتون">"تجزیه (parse)"</abbr> فرم استفاده کنید.
* <ahref="https://pyyaml.org/wiki/PyYAMLDocumentation"target="_blank"><code>pyyaml</code></a> - Required for Starlette's `SchemaGenerator` support (you probably don't need it with FastAPI).
* <ahref="https://pythonhosted.org/itsdangerous/"target="_blank"><code>itsdangerous</code></a> - در صورتی که بخواید از `SessionMiddleware` پشتیبانی کنید.
* <ahref="https://github.com/esnme/ultrajson"target="_blank"><code>ujson</code></a> - Required if you want to use `UJSONResponse`.
* <ahref="https://pyyaml.org/wiki/PyYAMLDocumentation"target="_blank"><code>pyyaml</code></a> - برای پشتیبانی `SchemaGenerator` در Starlet (به احتمال زیاد برای کار کردن با FastAPI به آن نیازی پیدا نمی‌کنید.).
* <ahref="https://graphene-python.org/"target="_blank"><code>graphene</code></a> - در صورتی که از `GraphQLApp` پشتیبانی می‌کنید.
* <ahref="https://github.com/esnme/ultrajson"target="_blank"><code>ujson</code></a> - در صورتی که بخواهید از `UJSONResponse` استفاده کنید.
Used by FastAPI / Starlette:
استفاده شده توسط FastAPI / Starlette:
* <ahref="https://www.uvicorn.org"target="_blank"><code>uvicorn</code></a> - for the server that loads and serves your application.
* <ahref="https://www.uvicorn.org"target="_blank"><code>uvicorn</code></a> - برای سرور اجرا کننده برنامه وب.
* <ahref="https://github.com/ijl/orjson"target="_blank"><code>orjson</code></a> - Required if you want to use `ORJSONResponse`.
* <ahref="https://github.com/ijl/orjson"target="_blank"><code>orjson</code></a> - در صورتی که بخواهید از `ORJSONResponse` استفاده کنید.
You can install all of these with `pip install "fastapi[all]"`.
می‌توان همه این موارد را با استفاده از دستور `pip install fastapi[all]`. به صورت یکجا نصب کرد.
## License
## لایسنس
This project is licensed under the terms of the MIT license.
Mohsen Mahmoodi
3 years ago
GitHub