فهرست مستندات¶
به مستندات APIFlask خوش آمدید!
نسخه ها¶
- آخرین نسخه: مستندات برای آخرین نسخه سورس کد
- V1: مستندات آخرین نسخه 1.
فهرست¶
برای یادگیری APIFlask به ترتیب زیر جلو بروید:
- مقدمه: توضیح کلی APIFlask
- مهاجرت از فلسک: راهنما و یاداشت های مربوط به مهاجرت از فلاسک.
- استفاده پایه: شروع کار با APIFlask.
- مدیریت ریکوئست ها: اطلاعات مقدماتی درباره دیکرویتور
@app.input. - فرمت کردن پاسخ ها: اطلاعات مقدماتی درباره دیکوریتور
@app.output. - طرحواره داده ها: معرفی و مقدمه ای درباره ساخت طرحواره برای ورودی/خروجی.
- ایجاد OpenAPI: معرفی ای درباره چگونگی کارکرد ایجاد OpenAPI و روش شخصی سازی آن با
@app.docو مقادیر کانفیگ آن. - احراز هویت:معرفی نحوه پشتیبانی از نحوه احراز هویت در برنامه شما.
- مستندات API: معرفی روش استفاده و کانفیگ ابزار های مستندسازی API.
- پیکربندی: لیستی از تمام متغیرهای پیکربندی داخلی.
- مثال ها: مجموعه ای از مثال های کاربردی.
فصل های زیر برای مشارکت کنندگانی که می خواهند در مورد APIFlask بیشتر بدانند مفید است
- مرجع API: مرجع API(ریفرنس) APIFlask.
- مقایسه و انگیزه: تفاوت های میان پروژه های مشابه و APIFlask.
- توسعه دهندگان: توسعه دهنگان APIFlask.
- تغییرات: تغییرات APIFlask در هر نسخه.
مستندات دیگر¶
من سعی خواهم کرد تمام کاربردهای اساسی در اسناد APIFlask را پوشش دهم. با این حال، برای استفاده های پیشرفته، ممکن است لازم باشد اسناد فریمورک و ابزارهایی را که APIFlask بر اساس آنها ساخته شده است بخوانید:
- فلسک: دانستن درباره فلسک ضروری است.
- مارشمالو: مرجع پیشرفته برای طرحواره.
- Flask-HTTPAuth: مرجع پیشرفته برای استفاده از
HTTPBasicAuthوHTTPTokenAuth. - webargs: مفید برای مشارکت کنندگان
- apispec: مفید برای مشارکت کنندگان
- OpenAPI: مشخصات OpenAPI
- طرح واره JSON: زمانی مفید است که می خواهید یک طرحواره خطای سفارشی تنظیم کنید و نمی خواهید از کلاس طرح استفاده کنید.