برنامه نویسی

نحوه ایجاد API Python در کمتر از 15 دقیقه

مقدمه

با تشکر از اکوسیستم غنی Python و چارچوب های حداقل دیگ بخار ، می توانید در کمتر از 15 دقیقه – حتی به عنوان یک مبتدی – از صفر به یک نقطه پایانی API بروید. در این وبلاگ ، ما شما را با استفاده از FastAPI ، یکی از کارآمدترین چارچوب های پایتون برای ساخت API های مدرن ، طی مراحل دقیق طی می کنیم.

قبل از شیرجه رفتن ، شایان ذکر است که در حالی که ساختن یک API اساسی سریع و سر راست است ، مقیاس بندی آن برای تولید نیاز به تجربه در امنیت ، تنظیم عملکرد و استقرار دارد. اگر به دنبال ایجاد یک سیستم آماده تولید با حداقل تلاش هستید ، استخدام توسعه دهندگان پایتون که می توانند وزنه برداری سنگین را برای شما انجام دهند ، هوشمندانه است.

بیایید شروع کنیم

چرا Fastapi را انتخاب کنید؟

چندین چارچوب پایتون در آنجا وجود دارد – Flask ، Django ، Tornado – اما Fastapi به سرعت محبوبیت خود را افزایش داده است:

  • مستندات Swagger تولید شده توسط خودکار
  • پشتیبانی async از جعبه
  • اشاره و اعتبار سنجی را از طریق Pydantic تایپ کنید
  • عملکرد رعد و برق به لطف Starlette

FastAPI توسعه و آزمایش API ها را به یک نسیم تبدیل می کند ، که برای نمونه سازی سریع یا ساخت برنامه های تمام عیار مناسب است.

مرحله 1: Fastapi و Uvicorn را نصب کنید
ترمینال خود را باز کنید و بسته های لازم را با استفاده از PIP نصب کنید:

pip install fastapi uvicorn
حالت تمام صفحه را وارد کنید

از حالت تمام صفحه خارج شوید

مرحله 2: اولین نقطه پایانی API خود را بنویسید
اکنون پرونده ای به نام main.py ایجاد کنید و کد زیر را اضافه کنید:
از Fastapi واردات Fastapi

app = FastAPI()

@app.get("https://dev.to/")
def read_root():
    return {"message": "Hello, World!"}

@app.get("/items/{item_id}")
def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "query": q}
حالت تمام صفحه را وارد کنید

از حالت تمام صفحه خارج شوید

آنچه در اینجا اتفاق می افتد:

  • ما برنامه FastAPI را آغاز می کنیم
  • ما دو نقطه پایانی را تعریف می کنیم:
  1. یک مسیر ریشه / که یک پیام خوش آمدید را برمی گرداند
  2. یک مسیر /موارد پویا /{item_id} که شناسه مورد و پرس و جو اختیاری را برمی گرداند

این پرونده اکنون API عملکردی شماست و کمتر از 10 خط کد طول کشید!

مرحله 3: API را به صورت محلی اجرا کنید
برای اجرای برنامه از UVicorn استفاده کنید:

uvicorn main:app --reload
حالت تمام صفحه را وارد کنید

از حالت تمام صفحه خارج شوید

مرورگر خود را باز کنید و به آنجا بروید http://127.0.0.1:8000بشر خواهید دید:

{"message": "Hello, World!"}
حالت تمام صفحه را وارد کنید

از حالت تمام صفحه خارج شوید

حالا برو بهhttp://127.0.0.1:8000/docs -FastAPI برای آزمایش نقاط پایانی خود ، UI تعاملی Swagger UI را ایجاد می کند. بله ، همه اینها خارج از جعبه است.

مرحله 4: اضافه کردن نقطه پایانی پست (اختیاری)
آیا می خواهید برخی از داده ها را بپذیرید؟ فقط این کد را اضافه کنید:

from pydantic import BaseModel

class Item(BaseModel):
    name: str
    price: float

@app.post("/items/")
def create_item(item: Item):
    return {"name": item.name, "price": item.price}
حالت تمام صفحه را وارد کنید

از حالت تمام صفحه خارج شوید

این به کاربران اجازه می دهد تا داده های JSON را به /items/ با یک نام و قیمت. FastAPI به طور خودکار ورودی را با استفاده از طرح Pydantic تأیید می کند – هیچ کد اضافی لازم نیست.

مرحله 5: بعد چه؟
اکنون یک API کاملاً کاربردی با قابلیت های GET و POST دارید. در کمتر از 15 دقیقه ، شما یک باطن مدرن ، مستند و گسترده ایجاد کرده اید. از اینجا ، می توانید:

  • به یک پایگاه داده متصل شوید (به عنوان مثال ، postgresql ، mongoDB)
  • تأیید اعتبار (OAUTH2 ، JWT)
  • مستقر در خدماتی مانند Heroku ، AWS یا Vercel
  • نقاط پایانی را برای عملکرد دنیای واقعی گسترش دهید

در حالی که شروع کار آسان است ، حفظ و مقیاس API برای کاربران واقعی ، انطباق امنیتی و بهینه سازی عملکرد نیاز به تخصص عمیق دارد. به همین دلیل مشاغل اغلب ترجیح می دهند توسعه دهندگان پایتون را با تجربه در معماری مقیاس پذیر و شیوه های DevOps استخدام کنند.

افکار نهایی

ساختن API لازم نیست یک کار دلهره آور باشد. پایتون با ابزارهایی مانند FastAPI ، به توسعه دهندگان این امکان را می دهد تا بدون قربانی کردن وضوح یا عملکرد ، سریع حرکت کنند. در این راهنمای کوتاه ، شما یک API را از ابتدا ایجاد کرده اید ، آن را آزمایش کرده اید و اسناد تعاملی را مورد بررسی قرار داده اید – همه در کمتر از 15 دقیقه.

اما وقتی نوبت به تولید می رسد ، به یاد داشته باشید: API ها فقط آغاز هستند. مدیریت کاربر ، بهینه سازی پایگاه داده ، کنترل بار و خطوط لوله استقرار در جایی است که توسعه دهندگان متخصص می درخشند. اگر می خواهید از نمونه اولیه به محصول بروید ، این یک حرکت هوشمندانه برای استخدام توسعه دهندگان پایتون است که می توانند ایده شما را به یک واقعیت مقیاس پذیر تبدیل کنند.

نوشته های مشابه

دیدگاهتان را بنویسید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *

دکمه بازگشت به بالا