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

332
Какой правильный код ответа REST для действительного запроса, но пустых данных?

Например, вы выполняете запрос GET для, users/9но нет пользователя с идентификатором # 9. Какой код ответа лучше? 200 ОК 202 Принято 204 Нет содержимого ошибка 400, неверный запрос 404 Не Найдено...

301
Каковы лучшие практики для вложенных ресурсов REST?

Насколько я могу судить, каждый отдельный ресурс должен иметь только один канонический путь. Итак, в следующем примере, какими будут хорошие шаблоны URL? Возьмем для примера представительство отдыхающих компаний. В этом гипотетическом примере каждой компании принадлежит 0 или более отделов, а...

288
Лучшие практики API-пагинации

Я хотел бы получить некоторую помощь в обработке странного крайнего случая с разбитым на страницы API, который я создаю. Как и многие API, этот разбивает на большие результаты. Если вы запросите / foos, вы получите 100 результатов (т.е. foo # 1-100) и ссылку на / foos? Page = 2, которая должна...

239
Почему Java Streams разовые?

В отличие от C # IEnumerable, где конвейер выполнения может выполняться столько раз, сколько мы хотим, в Java поток может быть «повторен» только один раз. Любой вызов терминальной операции закрывает поток, делая его непригодным для использования. Эта «особенность» отнимает много энергии. Я думаю,...

146
Вызов серверного метода для ресурса в режиме RESTful

Имейте в виду, что у меня есть элементарное понимание REST. Допустим, у меня есть этот URL: http://api.animals.com/v1/dogs/1/ А теперь я хочу, чтобы сервер заставлял собаку лаять. Только сервер знает, как это сделать. Допустим, я хочу, чтобы он выполнял задание CRON, которое заставляет собаку...

142
Когда я могу использовать параметры пути или параметры запроса в RESTful API?

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

127
Почему String.valueOf (null) вызывает исключение NullPointerException?

согласно документации метод String.valueOf(Object obj)возвращает: если аргумент равен null, то строка равна "null"; в противном случае obj.toString()возвращается значение. Но почему, когда я пытаюсь сделать это: System.out.println("String.valueOf(null) = " + String.valueOf(null)); вместо этого...

97
GB английский или американский английский?

Если у вас есть API, и вы являетесь разработчиком из Великобритании с очень международной аудиторией, должен ли ваш API setColour() или setColor() (Возьмем одно слово в качестве простого примера.) Инженеры из Великобритании часто защищают свое «правильное» написание, но можно возразить, что...

84
Срок действия токена истек - JSON REST API - Код ошибки

У меня есть JSON REST API. Рукопожатие даст вам токен, действительный в течение 15 минут. Все звонки, которые вы делаете в течение этих 15 минут, должны работать нормально. Через 15 минут я возвращаю объект ошибки (включая код, сообщение, success = false), но мне также было интересно, какой код...