Вопросы с тегом «api-design»

30
Должны ли микросервисы общаться друг с другом?

Я разрабатываю приложение с использованием Micro-Services, и я не уверен в том, какой механизм лучше использовать для сбора данных из нескольких служб. Я считаю, что есть два варианта: Интегрируйте межсервисный механизм связи, который позволяет сервисам общаться напрямую. API-шлюз будет вызывать...

27
Зачем использовать непрозрачный «дескриптор», который требует приведения в открытом API, а не типобезопасный структурный указатель?

Я оцениваю библиотеку, публичный API которой в настоящее время выглядит следующим образом: libengine.h /* Handle, used for all APIs */ typedef size_t enh; /* Create new engine instance; result returned in handle */ int en_open(int mode, enh *handle); /* Start an engine */ int en_start(enh handle);...

26
Микросервисы и хранение данных

Я подумываю о переносе монолитного REST API на микросервисную архитектуру, и меня немного смущает хранение данных. На мой взгляд, некоторые из преимуществ микросервисов: Горизонтально масштабируемый - я могу запустить несколько избыточных копий микросервиса, чтобы справиться с нагрузкой и / или...

26
Есть ли список общих имен пользователей, которые нужно зарезервировать в новой системе?

Этот вопрос был перенесен из переполнения стека, потому что на него можно ответить в Software Engineering Stack Exchange. Мигрировал 8 лет назад . Мне нужно зарезервировать имена пользователей на моем новом сайте. Они обычно делятся на три категории 1) имена пользователей, которые никто не должен...

25
Можно ли вернуть HTML из API JSON?

В моем текущем проекте я отвечаю за реализацию службы, которая включает использование только что созданных API RESTful, документированных как исключительно поддерживающие JSON. Клиент последовательно делает запросы с заголовком accept 'application / json' и типом контента 'application / json'....

25
RESTful API: HTTP-глаголы с общими или конкретными URL-адресами?

При создании API RESTful следует ли использовать HTTP-глаголы для одного и того же URL-адреса (когда это возможно) или мне следует создавать определенный URL-адрес для каждого действия? Например: GET /items # Read all items GET /items/:id # Read one item POST /items # Create a new item PUT...

25
При создании API я должен придерживаться небольших функций и большого количества вызовов или нескольких вызовов и больших функций?

У меня есть платформа рельсов, которую я поддерживаю. На нем много разных веб-приложений. Однако теперь клиент запрашивает API, чтобы они могли держать пользователей на своем сайте, но воспользоваться некоторыми автоматизированными задачами, которые у нас есть. Платформа используется для создания...

25
Дизайн API: конкретный или абстрактный подход - лучшие практики?

При обсуждении API-интерфейсов между системами (на бизнес-уровне) в нашей команде часто бывают две разные точки зрения: некоторые люди предпочитают более общий, скажем так, общий абстрактный подход, а другие - прямой «конкретный» подход. Пример: дизайн простого API «поиск человека». конкретная...

24
Как REST API подходит для домена, основанного на командах / действиях?

В этой статье автор утверждает, что Иногда требуется представить в API операцию, которая по своей природе не является RESTful. и это Если API имеет слишком много действий, то это указывает на то, что он был разработан с точки зрения RPC, а не с использованием принципов RESTful, или что данный API,...

24
Должен ли я создать свои собственные коды состояния HTTP? (а-ля Твиттер 420: Повысьте спокойствие)

Этот вопрос перенесен из-за сбоя сервера, потому что на него можно ответить в Software Engineering Stack Exchange. Мигрировал 6 лет назад . В настоящее время я реализую HTTP API, мой первый в истории. Я тратил много времени, просматривая страницу Википедии с кодами состояния HTTP, потому что я...

24
Рекомендуемый код состояния HTTP для ответа «превышен лимит плана»

Я разрабатываю REST API для проекта, в котором пользователи всегда используют один из нескольких «планов» - каждый план определяет некоторые ограничения ресурсов, например, максимальное количество пользователей, которое может иметь учетная запись, или максимальное количество данных, которые они...

23
Каков наилучший шаблон для добавления существующего элемента в коллекцию в REST API?

Я разрабатываю прагматичный REST API и немного застрял в том, как лучше всего добавить существующие сущности в коллекцию. Моя модель домена включает в себя проект, который имеет коллекцию сайтов. Это строгое отношение «многие ко многим», и мне не нужно создавать сущность, которая явно моделирует...

23
Как лучше всего вы представляете двунаправленную синхронизацию в REST API?

Предполагая систему, в которой есть веб-приложение с ресурсом, и ссылку на удаленное приложение с другим подобным ресурсом, как вы представляете двунаправленное действие синхронизации, которое синхронизирует «локальный» ресурс с «удаленным» ресурсом? Пример: У меня есть API, который представляет...

22
Функция возвращает true / false против void при успешном завершении и выдает исключение при сбое

Я строю API, функцию, которая загружает файл. Эта функция не будет возвращать ничего / пусто, если файл был загружен правильно, и выдает исключение при возникновении проблемы. Почему исключение, а не просто ложь? Потому что внутри исключения я могу указать причину сбоя (нет соединения, отсутствует...

20
Нужно ли всегда знать, что делает API, просто взглянув на код?

Недавно я занимался разработкой своего собственного API, и с таким большим интересом к разработке API меня очень интересовало, как я могу улучшить свой дизайн API. Один аспект, который возник несколько раз: (не пользователями моего API, а в моем наблюдении за обсуждением этой темы): нужно просто...

20
«Публичные API вечны: только один шанс сделать это правильно»?

В книге об ОС я только что прочитал: «Публичные API вечны: только один шанс сделать это правильно». Это правда? Это применимо только в API операционных систем или других API тоже? Например, будет ли это так для API-приложений Android, таких как Tasker, Locale и...

19
REST API Design: несколько вызовов против одного вызова API

Мы разрабатываем Rest API для веб-сайта электронной коммерции, который будет использоваться мобильными приложениями. На главной странице приложения нам нужно назвать несколько ресурсов, таких как слайдеры, лучшие бренды, самые продаваемые продукты, трендовые продукты и т. Д. Два варианта выполнения...

19
Почему у API коллекций Java нет последнего метода? [закрыто]

Закрыто . Этот вопрос основан на мнении . В настоящее время не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 5 лет назад . Это для упорядоченных коллекций, например, java.util.List. Почему разработчики...

18
Абстракция базы данных - это перебор?

После ознакомления с многочисленными уровнями абстракции базы данных я начинаю задаваться вопросом, в чем смысл каждой библиотеки, изобретающей свою собственную парадигму для доступа к данным. Получение нового DAL похоже на изучение нового языка снова и снова, когда обычно все, что я хочу сделать,...

17
Почему в Java String нет методов статической обработки строк?

Почему разработчики Java не создали статические версии методов манипуляции со строками в java.lang.Stringклассе? Следующие методы - это то, к чему я обращаюсь, но вопрос можно распространить и на другие нестатические методы в классе. concat(String) substring(int, int) replace(char, char)...