Дизайн api

в нашей компании у нас есть несколько API, которые возвращают некоторые данные JSON. Перед отправкой, например, данных в серверную часть с помощью PUT, PATCH или POST, нам нужно выполнить некоторую проверку в разных клиентах (веб, мобильные приложения и т. д.). Прямо…

76

Например, допустим, у меня есть конечная точка для получения списка зданий, которые могут быть либо квартирами, либо домами. Клиент может фильтровать по квартирам или домам. У квартиры есть свойство floor, которого нет у дома, поэтому floor будет равно null для всех…

50

Я просматривал старую, практически нетронутую часть кодовой базы моей компании и нашел один API. Он выполняет следующие действия. POST API с путем host/entities/trigger, который извлекает список идентификаторов сущностей из базы данных. Для каждого из этих…

59

Я рассматриваю List<T>.AsReadOnly() метод. Так как List<T> сам по себе является IReadOnlyCollection<T>. (Он реализует IReadOnlyList<T>, а IReadOnlyList<T> реализует IReadOnlyCollection<T>), реализация AsReadOnly() технически может быть return this;, которая не имеет…

116

Я столкнулся с этой проблемой и хотел бы рассмотреть здесь свой подход к ее решению. Микросервис Client посылает HTTP-запрос на Service A и ожидает ответа. Service A подключен к DB A. Когда он получает запрос от Client, он должен сохранить его в DB A и переслать его…

50

Я видел похожие вопросы, но в этом случае код, развернутый на всех этапах (local, dev, staging, prod), будет одинаковым. Идея заключается в том, чтобы иметь специальное поле в одном конкретном запросе, что-то вроде isTest, которое позволит определенной конечной точке…

53

У меня есть API обновления (PUT/PATCH) entity/{id} для обновления определенной сущности в моей БД. Допустим: entity { id: number, // Primary key, unique, not null content: text, parentId: number // Foreign key, nullable, points to another entity's Id from the same…

121

При пакетном удалении ресурса. Например, удаление всех Заказов, принадлежащих Клиенту 99: DELETE /customer/99/order Если существуют определенные бизнес-правила1, которые не позволяют удалять заказы, соответствующие определенным критериям. Например: Заказы, которые были…

111

Методы интерфейса по умолчанию в C# 8 и методы расширения объединяет то, что вы можете "добавить" метод с реализацией в интерфейс. "Добавить" здесь в кавычках, потому что для методов расширения это не совсем точно. Методы расширения только связывают метод с типом, что…

411

Это происходит в контексте распределенных вычислений. Имеется служба A, которая владеет базой данных и предоставляет API для обновления сущностей в этой базе данных. С течением времени сервис развивался, и мы собираемся добавить к нему сложную возможность. Эта…

576

У меня есть несколько конечных точек REST API, настроенных для создания записи в блоге. Каждый пост в блоге принадлежит пользователю. У меня есть следующие маршруты: /users [GET, POST]: Get a list of all users, POST to this endpoint to create a new user /users/<id…

76

REST APIS - это унифицированный интерфейс. Лучше ли добавить функциональность в параметры поиска GET-запроса с помощью параметра запроса, чем добавлять вложенные идентификаторы ресурсов в коллекцию /exists или /exists/type. Должны ли идентификаторы ресурсов иметь…

121

Каковы передовые методы, которым я могу следовать, чтобы упростить или помочь абстрагироваться от моделирования сущностей, когда есть много похожих, но разных сущностей? У меня есть большая игровая система с разными типами учетных записей, представляющих конечного…

77

Извините, я бы оставил комментарий к другому вопросу, но у меня не хватает репутации. У меня та же проблема, что и в этом вопросе: Как указать много id и имя переменной в запросе REST API? У меня есть большой список из 800+ сотрудников. (Я должен показать их всех…

79

Я работаю над библиотекой C#, в которой API предоставляет несколько публичных интерфейсов и один конкретный класс-фабрику (который сам является реализацией интерфейса). Эта фабрика предоставляет реализации различных интерфейсов. Кроме фабрики, ни одна из реальных…

8 226

У нас есть .Net WebApi 2, над которым мы работаем уже довольно долгое время. По мере рефакторинга кода мы начали думать о том, что было бы лучше: а) "получить приложение по userid" или б) "получить приложение пользователя"? В настоящее время у нас есть 2 контроллера…

68

У нас есть публичный API. Пользователи будут обращаться к этому API, передавая различные Guid'ы в качестве идентификаторов сущностей. В API Guid будет преобразован во внутренний ID (Int32) для конкретной записи в нашей БД. Публичный API вызывает наш внутренний API, и…

446

Допустим, у меня есть REST API, которому нужно вернуть ширину объекта, но эта ширина может быть либо конкретным значением, либо диапазоном значений. Как лучше всего спроектировать API, чтобы справиться с этим? Например: "width": 35.5 "width": { "minimum": 34.2…

100

У меня есть проблема, касающаяся различения двух методов Rest, которые имеют одинаковое количество параметров пути: @GET @Path("image/{ratio}/") @Produces("image/png") @PermitAll public Response getImageMe(HttpServerRequest request, @PathParam("ratio") String ratio…

76

Я работаю над REST API для компании, которая до недавнего времени была ориентирована на австралийский рынок. Результатом этого является то, что у API есть ресурсы и области, которые моделируют австралийский рынок, особенно в отношении налогообложения, пенсионного…

193

Я ранее не разрабатывал нетривиальные HTTP API, поэтому прошу прощения, если что-то из этого является учебником. Когда я искал, мне не удалось найти ничего, подробно описывающего это. Допустим, у меня есть API, в который можно загрузить некоторые данные, а затем…

55

У меня есть элементы, и я создаю API, который проверяет различные аспекты элемента. Например: имеет ли он правильную высоту, ширину или глубину. Мое тело запроса выглядит так { height_check: true, width_check: true, depth_check: true } Ответ выглядит так…

85

Допустим, мы хотим написать класс Java, который представляет список фиксированного размера. Назовем его Chunk.java (в смысле, он представляет собой кусок данных, который нужно обработать или отправить куда-то). Моя реализация этого класса может быть описана следующим…

75

Допустим, у нас есть система отмены/возврата, и у нас есть суперкласс, хранящий объект, который позже должен сформировать дерево атрибутов, которые можно отменить/повторить. Это потребует, чтобы каждый класс, который должен участвовать в отмене/возврате, расширялся от…

279

Люди говорят "не раскрывайте первичные ключи из базы данных в вашем API", потому что это большая утечка безопасности, поэтому я пытаюсь придумать способ: RESTful HTTP запросы для обращения к ресурсам на стороне сервера без необходимости использования их DB PK пример: Я…

514

У api есть одна конечная точка с некоторыми параметрами. На основе этих параметров я могу предсказать, сколько времени займет обработка запроса. Это может быть от нескольких секунд до десятков секунд. Когда ожидаемое время невелико, я хочу сделать ответ синхронным и…

136

Я разрабатываю REST API, в котором пользователи могут запрашивать данные с одного или нескольких датчиков, используя следующую схему: GET /sensors - returns a list of available sensors GET /sensors/<sensor_ids>/data - returns data for one or more sensors, specified by…

218

Я работаю с базовым REST API, через взаимодействие с пользователем на UI, JSON объект строится, включая массивы и POST отправляется на конечную точку, используя этот объект в качестве тела запроса. Например: "data": { "id": "424", "types": [ "01", "02" ] } Таким…

564

Я изо всех сил пытаюсь определить правильные конечные точки для RESTful API, учитывая следующие требования: У нас есть существующая конечная точка /customers, которая при вызове с глаголом GET возвращает список клиентов, который выглядит так: { "id": "some-id", "name…

334