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

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

6
Что общего у замечательных API? [закрыто]
Закрыто . Этот вопрос должен быть более сфокусированным . В настоящее время он не принимает ответы. Закрыто 6 лет назад . Locked . Этот вопрос и его ответы заблокированы, потому что вопрос не по теме, но имеет историческое значение. В настоящее время он не принимает новые ответы или взаимодействия. Что …
15 api-design 

7
Как создать аутентификацию пользователя из клиентских приложений?
Я разрабатывал приложение, которое будет поддерживать многих пользователей. Дело в том, что я не могу понять, как аутентифицировать клиента / пользователя. Я создаю приложение, такое как http://quickblox.com/, где я предоставляю учетные данные своим пользователям, и они будут использовать их для создания N приложений, в которых они не смогут ввести свое …

1
Как правильно вкладывать ресурсы в модель REST?
Я разрабатываю REST API сервиса и застрял на правильном способе вложения ресурсов. Ресурсы: партнеры, тикеты, настройки Связи между ресурсами: у партнера много билетов, партнер имеет набор настроек, Деловая логика: Вы можете перечислить всех партнеров в качестве анонимного пользователя, Вы можете добавить новый билет для указанного партнера в качестве анонимного пользователя, …
14 api  rest  api-design 

5
В разработке API, когда использовать / избегать специального полиморфизма?
Сью разрабатывает библиотеку JavaScript Magician.js. Его стержень является функцией, которая извлекает Rabbitиз переданного аргумента. Она знает, что ее пользователи могут захотеть вытащить кролика из a String, a Number, a Function, возможно, даже a HTMLElement. Имея это в виду, она могла бы разработать свой API следующим образом: Строгий интерфейс Magician.pullRabbitOutOfString = …

3
Должны ли внутренние идентификаторы быть открытыми или нет в REST API?
На основании того, что говорит этот парень: http://toddfredrich.com/ids-in-rest-api.html Предположим, он прав в использовании UUID для идентификации ресурсов API. Затем я сталкиваюсь с проблемами, пытаясь реализовать это таким образом: class FooEntity { final String id = null; //auto-generated by my backend (mongodb), not shared final UUID uid = UUID.randomUUID(); //the resource …

4
Используйте состав и наследование для DTO
У нас есть веб-API ASP.NET, который предоставляет REST API для нашего одностраничного приложения. Мы используем DTO / POCO для передачи данных через этот API. Проблема в том, что эти DTO со временем становятся больше, поэтому мы хотим реорганизовать DTO. Я ищу "лучшие практики", как проектировать DTO: В настоящее время у …
13 rest  api-design  web-api  dto  poco 

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

8
Является ли интерфейс, предоставляющий асинхронные функции, утечкой абстракции?
Я читаю книгу « Принципы, практики и модели внедрения зависимостей» и читаю концепцию утечки абстракций, которая хорошо описана в книге. В эти дни я делаю рефакторинг базы кода C #, используя внедрение зависимостей, так что вместо блокирующих используются асинхронные вызовы. Поступая так, я рассматриваю некоторые интерфейсы, которые представляют абстракции в …

3
Плоский или вложенный JSON для иерархических данных?
Я переключался туда и обратно ~ 5 раз уже. Эта конечная точка REST по /api/tags/желанию предназначена для внутреннего использования (без сторонних клиентов), я единственный, кто работает с ней. Я выбираю между этими двумя представлениями: Плоский { "types":[ { "id":1, "text":"Utility" }, { "id":7, "text":"Lease Terms" }, ], "tags":[ { "id":8, …
12 rest  api-design  json 

2
Должен ли я быть допускающим неизвестных параметров?
Я проектирую RESTful API и столкнулся с проблемой заголовка, для ясности: Должен ли я быстро потерпеть неудачу, если клиент отправляет нераспознанный параметр? Например, http://example.com/api/foo?bar=true&paula=bean Выше указан barдопустимый параметр, но paulaон не указан API. Нужно ли мне Предупредить клиента об ошибке Терпеть неудачу быстро Игнорируй это Если я предупреждаю клиента, я …
12 rest  api-design 

1
Поддерживать API и использовать идиомы в порту
Я работаю над портом от Python до Rust и наткнулся на некоторый код, который не может быть выражен так же естественно в Rust, как в Python. Одним из случаев этого является использование параметров по умолчанию: class Foo: def __init__(self, a="Hello"): self._a = a В Rust вы можете реализовать это с …

2
Реализация шаблона команды в API RESTful
Я нахожусь в процессе разработки HTTP API, надеюсь, сделать его максимально RESTful. Есть некоторые действия, функциональность которых распространяется на несколько ресурсов, и иногда их нужно отменить. Я подумал, что это звучит как шаблон команды, но как я могу смоделировать его в ресурс? Я представлю новый ресурс под названием XXAction, такой …

2
C ++ Library API Design
Я ищу хороший ресурс для изучения хорошего дизайна API для библиотек C ++, просмотра общих объектов / библиотек и т. Д. Есть много ресурсов по написанию хороших API, хороших классов, шаблонов и так далее на уровне исходного кода, но почти ничего о собирать вещи в общие библиотеки и исполняемые файлы. …

2
Как спроектировать конечные точки API для публикации дочернего объекта и для получения всех детей всех родителей?
Например, у меня есть объекты: Клиент, Отчет. У клиента может быть много отчетов, и я думаю, что конечная точка для управления одним отчетом должна быть вложена следующим образом: /clients/{client_id}/reports/{report_id} Что касается всех отчетов одного клиента, ожидается, что enpoint: /clients/{client_id}/reports Но как должна выглядеть конечная точка для получения всех отчетов всех …
12 rest  api  api-design 

3
Плохо ли использовать дефисы в ключах JSON?
Я вижу много вопросов, связанных с доступом к ключам JSON, в которых используются дефисы (кебаб-кейс), но теперь я задаюсь вопросом, стоит ли мне просто придерживаться camelCase или snake_case в моих ключах. Я знаю, что дефисы также могут создавать сложные отображения при переносе между языками. Я видел, как некоторые библиотеки десериализации …

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