Запитання з тегом «api-design»

Інтерфейс прикладного програмування (API) Дизайн обговорює кращі практики створення бібліотек, призначених для загального призначення або для загального користування.

5
Як API REST підходить для домену на основі команд / дій?
У цій статті автор стверджує, що Іноді потрібно виявити операцію в API, яка по суті не є RESTful. і це Якщо API має занадто багато дій, то це свідчить про те, що або він був розроблений з точки зору RPC, а не з використанням принципів RESTful, або що відповідний API, …

5
Наскільки найкраще ви представляєте двонаправлену синхронізацію в програмі REST?
Якщо припустити систему, де є веб-додаток з ресурсом, та посилання на віддалену програму з іншим подібним ресурсом, як ви представляєте двонаправлену синхронізацію, яка синхронізує "локальний" ресурс із "віддаленим" ресурсом? Приклад: У мене є API, який представляє список todo. GET / POST / PUT / DELETE / todos / тощо. Цей …

2
Який найкращий зразок для додавання наявного елемента до колекції в API REST?
Я розробляю прагматичний API REST, і я трохи застряг у тому, як найкраще додати існуючі сукупності до колекції. Моя модель домену включає проект, який має колекцію Сайтів. Це суворий зв'язок між багатьма і багатьма, і мені не потрібно створювати сутність, яка явно моделює відносини (тобто 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
Ми розробляємо 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
Виявлення численних "державних машин"
Я щойно прочитав цікаву статтю під назвою " Надто мило з поверненням урожаю" # Це змусило мене замислитися, що найкращий спосіб виявити, чи є IEnumerable фактично перелічуваною колекцією, чи це машина машини, створена за допомогою ключового слова дохід. Наприклад, ви можете змінити DoubleXValue (зі статті) на щось на зразок: private …
17 c#  api-design 

3
Коли я повинен використовувати string_view в інтерфейсі?
Я використовую внутрішню бібліотеку, яка була створена для імітації запропонованої бібліотеки C ++ , і десь за останні кілька років я бачу, що її інтерфейс змінився від використання std::stringна string_view. Тож я достойно змінюю свій код, щоб відповідати новому інтерфейсу. На жаль, те, що мені потрібно передати, - це параметр …

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

3
Версії API REST. У кожного 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: як спроектувати відповідь?
Ми розробляємо API RESTful, який в основному призначений для задоволення потреб одного клієнта. Через свої особливі обставини, цей клієнт повинен зробити якомога менше запитів. API обробляє i18n за допомогою заголовка мови Accept у запитах. Це працює для всіх речей, які повинен зробити клієнт, за винятком однієї функції, у якій клієнт …
15 rest  api  api-design  http 

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.