Многие крупные API-интерфейсы следуют стандарту «OpenApi», что помогает сделать ваш API-интерфейс легко понятным для любого разработчика.Вы можете строго следовать этому, но даже если вы не попытаетесь реализовать некоторые из базовых принципов, и люди смогут быстро использовать ваш API.
Например: Используйте GET, POST, PUT, DELETEкак они должны .. Звучит просто, но я видел много реализаций, где GET используется для каждого запроса.Это, конечно, работает (если вы строите его таким образом), но позволяет легче ошибиться, и вам нужно больше конечных точек, чем необходимо.
Также: пользователь может очистить имена и структуры для ваших конечных точек.
api.website.com / tickets / [ID, например.12]
api.website.com / orders / [ID например.354]
Теперь, если я, как разработчик, хочу получить определенный счет с идентификатором 76 ... Теперь я могу угадать конечную точку: api.website.com/invoices/76
Если яхочу получить данные, которые я использую GET api.website.com/invoices/76
Если я хочу обновить счет, я использую PUT api.website.com/invoices/76
Использованные источники:
https://swagger.io/blog/api-design/api-design-best-practices/ https://swagger.io/resources/articles/best-practices-in-api-documentation/ https://blog.mwaysolutions.com/2014/06/05/10-best-practices-for-better-restful-api/