نشانی وب، روش، قراردادهای خطا («GET»، «POST»، «PUT»، «DELETE»)

یک API قابل اعتماد و قابل فهم با قوانین روشن برای ساخت رابط ها شروع می شود. ما به بهترین شیوه های REST پایبند هستیم تا هر توسعه دهنده بداند چه چیزی انتظار می رود: ساختار URL منطقی است، روش ها برای عمل مناسب هستند و خطاها به راحتی تفسیر می شوند.

این آستانه ورود را کاهش می دهد، ادغام را ساده می کند و اجازه می دهد تا سیستم بدون هرج و مرج مقیاس شود.

قراردادهای روش های URL و HTTP

• نهادهای تودرتو به عنوان یک سلسله مراتب ('/users/42/sessions ')
• تمام درخواست ها از طریق HTTPS انجام می شود

استانداردهای مدیریت خطا

جی سون
{
«خطا»: {
«کد»: 400، «پیام»: «فیلد مورد نیاز از دست رفته: ایمیل»، «جزئیات»: {...}
}
}

مزایای توسعه دهنده

• رویکرد یکپارچه به تمام ماژول ها و اشخاص
• اشکال زدایی آسان و ورود به سیستم به لطف کدهای استاندارد و فرمت های
• سازگاری با تولید خودکار OpenAPI/Swagger، Postman، SDK
• پشتیبانی، تست و CI/CD را ساده می کند

جایی که بسیار مهم است

• پروژه ها با تیم های توسعه چندگانه
• معماری میکروسرویس یا رویکرد API-first
• سیستم با بسیاری از نهادها و تعاملات

قراردادهای یکنواخت API را قابل اعتماد، قابل فهم و راحت می سازد. ما به بهترین شیوه های REST پایبندیم تا هر ادغام به سرعت، بدون سوء تفاهم و با حداکثر پیش بینی انجام شود.