Описание тега api-design

Описание тега Вопросы с тегом
Дизайн API - это процесс определения и предоставления набора согласованных сигнатур методов, возвращаемых значений и документации, предназначенных для использования другими разработчиками для обеспечения программного доступа к данным.
1 ответ

Метод HTTP - POST против PATCH или PUT - когда пользователь не собирается что-либо обновлять на самом деле

Иногда пользователь не собирается отправлять данные на сервер для обновления ресурса, но ресурс будет обновляться сервером автоматически. Я думаю, что лучший пример - деактивация профиля. Я опишу пример ниже. Пример: пользователь пытается деактивиро…
05 мар '17 в 15:16
1 ответ

Kairos API - получить ответ JSON

Я хотел бы использовать API Kairos для распознавания лиц. Кажется, довольно хорошая система, но понятия не имею, как ловить примеры. Если я использую строку, она пуста после процесса. В документации по API и в репозитории GitHub нет примеров этого: …
11 апр '16 в 07:43
1 ответ

Как итеративно анализировать и сохранять ответы XML, которые входят в одну строку?

Я делаю вызовы API, то есть извлекаю идентификаторы, каждый вызов представляет 10000 идентификаторов, и я могу получить только 10000 одновременно. Моя цель - сохранить каждый вызов XML в списке, чтобы автоматически подсчитать, сколько человек на пла…
21 авг '17 в 15:11
0 ответов

Загрузочный образ Jquery API Tumblr

Я хотел бы использовать API Tumblr с JS, чтобы рисовать последние опубликованные изображения в блог движением мыши. Я успешно нарисовал ссылки на изображения в формате HTML, но мне нужна помощь в реализации изображений API. Я сделал JSfiddle - я соб…
01 сен '18 в 18:18
1 ответ

Какой код возврата http должен быть, если нет доступных данных

Например, у меня есть метод API /api/orders.getOrders который на самом деле всегда существует. Если этот метод не возвращает данные в следующем формате, я должен отправить 404 или 200 http код ответа? { "orders":[] }
29 июл '16 в 12:48
2 ответа

REST Api для ресурсных ассоциаций

Пытаясь смоделировать интерфейс REST для системы, мне трудно понять, какой подход будет наилучшим. Рассмотрим наличие объекта типа resource и другой объект, который описывает их ассоциации: resourceAssoc, Ассоциации могут быть n типы, но это не важн…
26 фев '15 в 18:41
1 ответ

Как составить несколько вызовов API в шлюз API?

Я ищу, как использовать API-шлюз в моем проекте. Моя текущая идея шаблона API-шлюза состоит в том, чтобы создать слой составных API, вызывающих несколько API, и представить составные API-интерфейсы через API-шлюз. Исследуя другие области, я обнаружи…
06 май '18 в 05:47
0 ответов

JS: Используйте одну и ту же функцию для двух API: Chainable sync. и обещания

Проблема в том, что если вы хотите использовать ту же функцию синхронно и в Promise, использование arguments будет отличаться, потому что первые аргументы могут прийти от обещания. Есть ли лучшее решение, чем мой нынешний способ? В качестве примера …
19 авг '16 в 11:08
1 ответ

Какой код ответа HTTP использовать для неудачного запроса POST?

Какой код ответа HTTP должен быть возвращен, если запрос POST не был успешным и тело запроса было правильно отформатировано? Для успешного запроса POST я использую 201 - Создано, но нет эквивалентного не созданного кода. Я думаю, что либо 400 - плох…
13 ноя '17 в 16:55
1 ответ

HATEOAS связывает с PUT/POST

Каков наилучший способ представить ссылку на HATEOAS для POST/PUT/PATCH на ресурсе? Эти операции имеют полезную нагрузку, но у нас не будет возможности представить полезную нагрузку в ссылке HATEOAS, поскольку они не определены заранее и могут быть …
09 сен '15 в 02:25
4 ответа

Массив структур или одна структура с массивом для каждого из его свойств

При разработке API я могу захотеть сохранить детали (например, запущенный процесс) в моей собственной структуре. Однако, если я собираюсь сделать это для более чем 1 процесса, то есть мне нужно несколько структур, если у меня будет массив структур и…
18 фев '10 в 16:11
1 ответ

Получение результата от асинхронного API

Я создаю API для обработки с помощью Lumen, процесс обработки занимает около 1-3 секунд на запрос. До сих пор я делал это с помощью очереди заданий и beanstalkd, и это было асинхронно, то есть я возвращал job_id, чтобы позже я мог проверить результа…
03 апр '18 в 08:01
0 ответов

Свободный дизайн API в C# с вложенными общими ограничениями

В настоящее время я реализую API настройки IoC для внутреннего использования (в значительной степени Autofacмодульная система). У нас есть Modules, которые настраиваются через строго типизированную конфигурацию, и я хочу, чтобы модуль мог требовать …
22 окт '18 в 12:54
0 ответов

Как сделать цепной интерфейс, используя функции конструктора в Javascript?

Я хочу цепной интерфейс, похожий на jQuery. Тем не менее, все учебные пособия по прототипам, доклады, исходные коды jQuery не проясняют этого, поэтому очень ценю помощь в решении этой проблемы. В jQuery я могу вызывать jQuery('. Apple'), но также jQ…
30 июл '17 в 16:42
0 ответов

Проблема разработки ASP.NET Web API 2 (C#)

У меня есть API, который работает в качестве промежуточного программного обеспечения между API оплаты и клиентов, структура что-то вроде этого большинство сервисов, доступных в api оплаты, имеют 5 общих параметров, поэтому я создал базовый класс, ко…
08 сен '16 в 10:56
0 ответов

Лучшие практики для нескольких приложений NodeJS

В последнее время я работаю над решением SaaS для предприятий. Весь продукт структурирован как 3 приложения: Back-end: API Модуль автоматизации (в основном набор крон и очередей заданий) Внешний интерфейс Веб-приложение Мы начинаем работать с различ…
09 окт '18 в 15:41
0 ответов

Имеет ли смысл REST для API сбора событий?

Я создаю API для сбора событий с сайта электронной коммерции. Поток данных, кроме аутентификации и кодов ответов HTTP, будет полностью от клиента к серверу. Имеет ли смысл разрабатывать такой API-интерфейс RESTful? Например, я не уверен, получу ли я…
18 ноя '14 в 14:39
1 ответ

В веб-API не является ли удаление DELETE ALL слишком опасным?

При изучении дизайна веб-API (независимо от конкретной технологии) я часто сталкиваюсь с этими двумя DELETE глагол: DELETE /SomeResource/123 /* deletes entity with ID 123 */ DELETE /SomeResource/ /* deletes all entities */ У меня всегда возникает ощ…
19 окт '16 в 13:41
1 ответ

Должен ли ответ остальных API содержать идентификатор ресурса?

Что является хорошей практикой или стандартом в остальных API, должен ли ответ сервера содержать идентификатор ресурса? Например, этот ответ содержит идентификатор ресурса GET /users/5 { "user_id": 5 "first_name" : "John", "last_name" : "Doe", "minu…
05 июл '17 в 07:57
1 ответ

Схема именования URI для API с виртуальными ресурсами + логический параметр

Я проектирую свой первый веб-API, и у меня возникают трудности с выбором схемы именования для URI. API не обращается к реальным ресурсам, вместо этого он делается для принятия запроса, запуска некоторой логики в строке запроса, накапливания соответс…
27 ноя '17 в 09:31