Описание тега apiary

Платформа нового поколения для создания и использования REST API.
1 ответ

Пасека, ограничивающая возврат ответа

Поэтому я использую Apiary для хранения и массива данных, а затем вызываю данные для отображения в HTML, но я хочу, чтобы Apiary посылал ограниченный объем данных в HTML, а не полный массив. Все еще пытаюсь разобраться с синтаксисом пасеки, поэтому …
20 июл '15 в 05:07
2 ответа

Пасека: есть ли способ определить параметры для параметров?

Я хотел бы определить параметры для параметров пасеки, в настоящее время я перечисляю их в описании: измерение = m (необязательно, строка, m)... измерение, например, м = метры, км = километры, ярды = ярды, ми = мили
1 ответ

Dredd - API Blueprint Testing Tool. "Неопределенная" проблема

Я установил dredd - API Blueprint Testing Tool и пытаюсь протестировать наш API API на предмет его реализации. В чертеже у меня есть только один ресурс, который правильно реализован на некотором хосте... но тест не пройден:( тестовая команда: dredd …
19 фев '14 в 13:31
1 ответ

api blueprint mson объект с разными значениями

У меня есть ответ коллекции, который возвращает массив пользовательских объектов и хочет иметь различные значения для пользовательских атрибутов без создания нескольких пользовательских объектов. Есть ли способ сделать это? # Group Users ## Users Co…
28 янв '19 в 11:05
1 ответ

Как документировать Webhooks в Apiary/API Blueprint

Я только начинаю с api blueprint, используя apiary для создания документов для нашего api. У нас есть и REST API, и несколько веб-хуков. API REST достаточно прост в создании, но я не могу понять, как лучше всего создать документацию для веб-хуков. М…
07 июн '16 в 16:41
1 ответ

Удалить вилку на пасеке Github

Есть ли способ снять вилку на github с пасеки? Я попытался настроить таргетинг на классы CSS, но не отображать их. Это все еще показывает на странице. .row.tocColumnTool.forkOnGitHub{ display: none; }
08 май '18 в 16:52
1 ответ

Пасека: обратитесь к нескольким моделям в теле

Кажется, что вы можете ссылаться на саму модель в неизмененном виде только из раздела полезных данных / тела: # Item [/] + Model { "name" : "an item" } ## GET + Response 200 [Item][] Есть ли способ вернуть массив модели или использовать модель в кач…
11 апр '14 в 13:33
1 ответ

Дредд, кажется, зависает с вызовами API на сервер asp.net kestrel

Когда я запускаю dredd, кажется, что он просто зависает после первого вызова API. Я не уверен, как отлаживать или диагностировать. Я работаю с asp.net 5 mvc 6 api сервис с dnx web команда. Как я могу увидеть, что происходит или в чем проблема? Я поп…
05 янв '16 в 16:10
0 ответов

Как я могу передать объект в качестве параметра на пасеку?

Я пытался передать объект в качестве параметра на пасеку, но он не работает правильно. Я новый пользователь редактора пасеки, и мне нужна ваша помощь! Тело запроса: { callbackUrl = "http://test.com", dlr = true, option1 = "option 1", option2 = "opti…
26 июл '17 в 08:54
0 ответов

Пересмешивать разные объекты с помощью идентификаторов

Есть ли способ смоделировать различные объекты, возвращаемые на пасеке маршруты / вопросы /1 и / вопросы /2? Если нет, есть ли альтернатива пасеке, где это возможно?
22 ноя '18 в 22:22
2 ответа

Как изменить владельца документа API в apiary.io?

Мне нужно изменить основной адрес электронной почты, связанный с документом API, поэтому, когда я делюсь документом с другими людьми, они видят это новое письмо, а не мое. В этом новом письме есть apiary.io, поэтому я говорю о передаче права собстве…
12 фев '14 в 19:03
1 ответ

Выберите инструменты для документов REST API

Я на самом деле использую Doxygen для документирования своего php REST-приложения и просто обнаруживаю, что Apiary & Swagger - хорошие инструменты для документирования API... Я хочу знать, есть ли способ автоматически сгенерировать документацию с по…
02 июл '15 в 05:08
1 ответ

Как я могу получить несколько%-кодированных параметров в шаблон URI пасеки?

Спецификация ApiaryIO - фактически RFC, на которую он указывает - указывает, что вы не можете использовать "." в имени параметра вам нужно закодировать его в "%2E". Это нормально, но, похоже, есть ошибка, когда Apiary может обрабатывать только одну …
27 янв '15 в 22:44
1 ответ

Как я могу использовать пасеку с JSON-RPC

Я пытаюсь использовать apiary.io для документирования API на основе JSON-RPC. Я могу получить отформатированные страницы, но консоль просто не работает. С JSON-RPC у вас обычно есть только 1 URI, как в случае с нашим API. Из-за этого при попытке опр…
27 апр '14 в 19:18
1 ответ

Условные параметры, основанные на значении другого параметра

Каков формат для параметров, если у меня есть условие, когда некоторые параметры могут быть изменены на основе значения другого параметра. Например: у меня есть способы оплаты: PayPal, банковский перевод и т. Д. + amount (required, number, `1200`) .…
29 июн '16 в 04:10
1 ответ

Повторное использование модели ресурсов в виде массива

Я документирую API, и у меня есть 2 очень похожих ответа. Одним из них является вызов /resource/{id}. Этот ответ возвращает модель ресурса. Другим вызовом является /resource/search{? Name,category}, который возвращает список ресурсов, поэтому мне ну…
07 апр '14 в 15:05
1 ответ

Укажите параметр запроса для одного метода HTTP

Чтобы проиллюстрировать мою проблему, я сделал сокращенный пример из учебного плана Apiary.io. FORMAT: 1A # Gist Fox API # Group Gist Gist-related resources of *Gist Fox API*. ## Gists Collection [/gists{?since}] ### List All Gists [GET] + Parameter…
15 окт '14 в 15:01
1 ответ

MSON с указанием даты и времени

Как следующий MSON может вывести схему с "format":"date-time", аналогично приведенному ниже? MSON: FORMAT: 1A # Some API ## series [/api/v1/series] Returns a list of series. ### View all series [GET] + Response 200 (application/json; charset=utf-8) …
10 сен '15 в 01:09
1 ответ

Определение параметров json post на пасеке

Я пытаюсь создать документацию для проекта, используя запросы json post.Теперь для получения запросов я могу легко определить параметры URI. Однако я хочу сделать то же самое для json и других почтовых запросов.Я попытался и хотел, чтобы это работал…
14 июл '15 в 14:14
0 ответов

Повторение структуры данных MSON с разными значениями

У меня есть много мест в моем API, где мне нужно будет описать список объектов. Каждый объект имеет одинаковые ключи / структуру, но разные значения. Как я могу настроить значения каждого экземпляра некоторой структуры данных, сохранив при этом весь…
14 сен '18 в 16:21