1- ترجیحا به جای استفاده از دامنه اصلی از subdomain یا حتی یک دامنه دیگر استفاده کنید.
api.mysite.ir یا mysiteapi.ir
2- نام موجودیت ها را جمع بکار ببرید api.mysite.ir/users و بصورت فعل استفاده نکنید api.mysite.ir/getusers
3- برای endpoint هایی که عملیات CRUD نیستند اگر بشود سلسله مراتبی تعریف می کنیم اگر نه از عنوان همان عملیات استفاده می کنیم. مثال :
برای رزرو یک تور api.mysite.ir/tours/{id}/reserve یا api.mysite.ir/reservetour
یا برای جستجو در تورها به مقصد و تعداد شب اقامت api.mysite.ir/tours/search?destination=tehran&nights=4
4- برای موجودیت های وابسته به موجودیت دیگر
نظرات مربوط به یک تور api.mysite/ir/tours/{id}/reviews
و برای PUT,Delete,GET یک نظر api.mysite/ir/tours/{id}/reviews/{review-id}
توصیه می شه بیشتر از 3 سطح نشه
اولین باشید که نظر می دهید