Сообщение Версия и секция в REST-API от 20.09.2022 17:19
Изменено 20.09.2022 17:20 Shmj
Версия и секция в REST-API
Возьмем, для примера, API от Микрософта, которые все делают наиболее канонично: https://learn.microsoft.com/en-us/partner-center/develop/get-a-customer-by-id
Вот такой API -эндпоинт
Тип сервиса вынесен в суб-домен. Версия — как часть адреса — v1. Далее просто без введения всяких разделов — сразу запрос к сущности customers. И там все в подобном роде. К примеру, запрос девайсов:
Без разделения на секции в адресе, хотя по смыслу в документации разделение они выполнили.
А вот Гугле и Амазон — поступают иначе — вводят секцию, к примеру:
и
Общее — везде есть версия. А вот раздел — MS как бы принципиально отказалась бить на разделы. Это просто так совпало или они придерживаются каких-то принципов?
Вот такой API -эндпоинт
GET https://api.partnercenter.microsoft.com/v1/customers/<customer-tenant-id>Тип сервиса вынесен в суб-домен. Версия — как часть адреса — v1. Далее просто без введения всяких разделов — сразу запрос к сущности customers. И там все в подобном роде. К примеру, запрос девайсов:
GET https://api.partnercenter.microsoft.com/v1/customers/47021739-3426-40bf-9601-61b4b6d7c793/deviceBatchesБез разделения на секции в адресе, хотя по смыслу в документации разделение они выполнили.
А вот Гугле и Амазон — поступают иначе — вводят секцию, к примеру:
https://developers.google.com/shopping-content/reference/rest/v2.1/orders/cancelи
GET /messaging/v1/orders/{amazonOrderId}Общее — везде есть версия. А вот раздел — MS как бы принципиально отказалась бить на разделы. Это просто так совпало или они придерживаются каких-то принципов?
Версия и секция в REST-API
Возьмем, для примера, API от Микрософта, которые все делают наиболее канонично: https://learn.microsoft.com/en-us/partner-center/develop/get-a-customer-by-id
Вот такой API -эндпоинт
Тип сервиса вынесен в суб-домен. Версия — как часть адреса — v1. Далее просто без введения всяких разделов — сразу запрос к сущности customers. И там все в подобном роде. К примеру, запрос девайсов:
Без разделения на секции в адресе, хотя по смыслу в документации разделение они выполнили.
А вот Гугле и Амазон — поступают иначе — вводят секцию, к примеру:
и
Общее — везде есть версия. А вот раздел — MS как бы принципиально отказалась бить на разделы. Это просто так совпало или они придерживаются каких-то принципов?
Так же в какой иерархии лучше — сначала секция потом версия или наоборот?
Вот такой API -эндпоинт
GET https://api.partnercenter.microsoft.com/v1/customers/<customer-tenant-id>Тип сервиса вынесен в суб-домен. Версия — как часть адреса — v1. Далее просто без введения всяких разделов — сразу запрос к сущности customers. И там все в подобном роде. К примеру, запрос девайсов:
GET https://api.partnercenter.microsoft.com/v1/customers/47021739-3426-40bf-9601-61b4b6d7c793/deviceBatchesБез разделения на секции в адресе, хотя по смыслу в документации разделение они выполнили.
А вот Гугле и Амазон — поступают иначе — вводят секцию, к примеру:
https://developers.google.com/shopping-content/reference/rest/v2.1/orders/cancelи
GET /messaging/v1/orders/{amazonOrderId}Общее — везде есть версия. А вот раздел — MS как бы принципиально отказалась бить на разделы. Это просто так совпало или они придерживаются каких-то принципов?
Так же в какой иерархии лучше — сначала секция потом версия или наоборот?