نشانی وب، روش، قراردادهای خطا («GET»، «POST»، «PUT»، «DELETE»)
این آستانه ورود را کاهش می دهد، ادغام را ساده می کند و اجازه می دهد تا سیستم بدون هرج و مرج مقیاس شود.
قراردادهای روش های URL و HTTP
| هدف | پرس و جو نمونه | ||
|---|---|---|---|
| «دریافت» | دریافت منابع | «دریافت/کاربران/42» | |
| «POST» | یک منبع جدید ایجاد کنید | «POST/users» | |
| «PUT» | به روز رسانی کامل منابع | «PUT/users/42» | |
| «PATCH» | به روز رسانی منابع جزئی (انتخاب کنید.) | «PATCH/users/42» | |
| «DELETE» | حذف منبع | «DELETE/users/42» |
استفاده از جمع («/users »، «/devices»، «/games »)
نهادهای تودرتو به عنوان یک سلسله مراتب ('/users/42/sessions ')
تمام درخواست ها از طریق HTTPS انجام می شود
استانداردهای مدیریت خطا
| کد | ارزش | پیام نمونه | |
|---|---|---|---|
| '400' | درخواست نامعتبر | 'فیلد مورد نیاز از دست رفته: ایمیل' | |
| «401» | غیر مجاز | «نشانه نامعتبر یا جلسه منقضی شده» | |
| دسترسی ممنوع | «دسترسی ممنوع به منابع» | ||
| '404' | یافت نشد | 'کاربر با شناسه 42 یافت نشد' | |
| '409' | درگیری (به عنوان مثال،. تکثیر) | «ایمیل در حال استفاده است» | |
| خطای "۴۲۲" | "سن فیلد" باید یک عدد باشد " | ||
| «500» | خطای سرور داخلی | «استثنا غیر منتظره، پشتیبانی تماس» |
ساختار پاسخ خطا:
- "جسون
- {
- «خطا «: {
- «کد «: 400،
- «پیام «:» فیلد مورد نیاز از دست رفته: ایمیل «،
- «جزئیات «: {...}
- }
- }
- ```
مزایای توسعه دهنده
درک سریع منطق API بدون مستندات غیر ضروری
رویکرد یکپارچه به تمام ماژول ها و اشخاص
اشکال زدایی آسان و ورود به سیستم به لطف کدهای استاندارد و فرمت های
سازگاری با تولید خودکار OpenAPI/Swagger، Postman، SDK
پشتیبانی، تست و CI/CD را ساده می کند
جایی که بسیار مهم است
پلت فرم API باز یا شریک
پروژه ها با تیم های توسعه چندگانه
معماری میکروسرویس یا رویکرد API-first
سیستم با بسیاری از نهادها و تعاملات
قراردادهای یکنواخت API را قابل اعتماد، قابل فهم و راحت می سازد. ما به بهترین شیوه های REST پایبندیم تا هر ادغام به سرعت، بدون سوء تفاهم و با حداکثر پیش بینی انجام شود.
تماس با ما
لطفاً فرم زیر را پر کنید، در اسرع وقت پاسخ خواهیم داد.