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

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

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

5
Как лучше всего вы представляете двунаправленную синхронизацию в REST API?
Предполагая систему, в которой есть веб-приложение с ресурсом, и ссылку на удаленное приложение с другим подобным ресурсом, как вы представляете двунаправленное действие синхронизации, которое синхронизирует «локальный» ресурс с «удаленным» ресурсом? Пример: У меня есть API, который представляет список задач. GET / POST / PUT / DELETE / todos / и …

2
Каков наилучший шаблон для добавления существующего элемента в коллекцию в REST API?
Я разрабатываю прагматичный REST API и немного застрял в том, как лучше всего добавить существующие сущности в коллекцию. Моя модель домена включает в себя проект, который имеет коллекцию сайтов. Это строгое отношение «многие ко многим», и мне не нужно создавать сущность, которая явно моделирует отношение (например, ProjectSite). Мой API позволит …
23 rest  api-design 

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

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

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

4
Почему у API коллекций Java нет последнего метода? [закрыто]
Закрыто . Этот вопрос основан на мнении . В настоящее время не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 5 лет назад . Это для упорядоченных коллекций, например, java.util.List. Почему разработчики языка не включили последний метод? Единственные …
19 java  api-design 

2
REST API Design: несколько вызовов против одного вызова API
Мы разрабатываем Rest API для веб-сайта электронной коммерции, который будет использоваться мобильными приложениями. На главной странице приложения нам нужно назвать несколько ресурсов, таких как слайдеры, лучшие бренды, самые продаваемые продукты, трендовые продукты и т. Д. Два варианта выполнения вызовов API: Одиночный звонок: www.example.com/api/GetAllInHome Несколько звонков: www.example.com/api/GetSliders www.example.com/api/GetTopBrands www.example.com/api/GetBestSellingProducts www.example.com/api/GetTrendingProducts Какой …
19 rest  api  api-design  url 

4
Абстракция базы данных - это перебор?
После ознакомления с многочисленными уровнями абстракции базы данных я начинаю задаваться вопросом, в чем смысл каждой библиотеки, изобретающей свою собственную парадигму для доступа к данным. Получение нового DAL похоже на изучение нового языка снова и снова, когда обычно все, что я хочу сделать, - это просто убедить слой вывести SQL-запрос, …
18 database  sql  api-design  dsl 

4
Почему в Java String нет методов статической обработки строк?
Почему разработчики Java не создали статические версии методов манипуляции со строками в java.lang.Stringклассе? Следующие методы - это то, к чему я обращаюсь, но вопрос можно распространить и на другие нестатические методы в классе. concat(String) substring(int, int) replace(char, char) toLowerCase() replace(CharSequence, CharSequence) toLowerCase(Locale) replaceAll(String, String) toString() replaceFirst(String, String) toUpperCase() split(String) toUpperCase(Locale) …
17 java  api-design  null 

3
Обнаружение множества «государственных машин»
Я только что прочитал интересную статью под названием Получение слишком мило с C # yield return Это заставило меня задуматься о том, как лучше всего определить, является ли IEnumerable фактической перечисляемой коллекцией или это конечный автомат, созданный с помощью ключевого слова yield. Например, вы можете изменить DoubleXValue (из статьи) на …
17 c#  api-design 

3
Когда я должен использовать string_view в интерфейсе?
Я использую внутреннюю библиотеку, которая была разработана для имитации предложенной библиотеки C ++ , и иногда в последние несколько лет я вижу, что ее интерфейс изменился с использования std::stringна string_view. Поэтому я покорно изменяю свой код, чтобы соответствовать новому интерфейсу. К сожалению, я должен передать параметр std :: string и …

2
Когда использовать вложенные ресурсы в RESTful API
У меня есть два ресурса: пользователи и ссылки. Пользователи могут иметь несколько ссылок, связанных с ними. Я разработал мой RESTful API, чтобы вы могли получить доступ к ссылкам, связанным с пользователем, по следующему URI: /users/:id/links Однако мне всегда нужно иметь URI только для ссылок - иногда мне могут понадобиться все …
16 api  rest  api-design 

3
Управление версиями REST API. Каждый API имеет свою версию
Очень часто указывается версия API REST в URL-адресе, особенно в начале пути, например что-то вроде: POST /api/v1/accounts GET /api/v1/accounts/details Тем не менее, я не видел ни одного дизайна, где версия связана с каждым API. Другими словами, мы поддерживаем версию каждого API отдельно. то есть: POST /api/accounts/v2 GET /api/accounts/details/v3 Используя этот …

1
RESTful API и i18n: как оформить ответ?
Мы разрабатываем RESTful API, который в основном предназначен для удовлетворения потребностей одного клиента. Из-за особых обстоятельств этот клиент должен сделать как можно меньше запросов. API обрабатывает i18n через заголовок Accept-Language в запросах. Это работает для всех вещей, которые должен сделать клиент, за исключением одной функции, в которой клиент должен хранить …
15 rest  api  api-design  http 

Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.