Вопросы по теме 'apiblueprint'

Как проверить ответ с помощью dredd?
Я пытаюсь проверить свою реализацию API с помощью моей документации, написанной в плане. Я ожидал, что dredd выйдет из строя, когда json, возвращаемый с сервера, будет отличаться от указанного в документации. Чтобы проверить это, я скопировал...
1404 просмотров
schedule 30.05.2023

Пасека: Экспорт API в формате JSON для генерации клиентского кода
Мы все знаем, что пасека качается (или нет... я думаю, что да), и мне было интересно, что нужно сделать, чтобы сделать еще один шаг вперед и разрешить пользователям экспортировать JSON-описание API? (Чтобы разработчики могли создавать скрипты для...
6025 просмотров
schedule 29.06.2022

JSON-RPC с APIBlueprint
Apiary предоставляет чистый интерфейс для объявления параметров URI, что позволяет легко экспериментировать через консоль с хорошим заполнением пустого интерфейса. Возможно ли это сделать для json-rpc или любого параметра тела http? Если нет, то...
277 просмотров
schedule 26.04.2023

Пасека: Есть ли способ определить опции для параметров?
Я хотел бы определить параметры для параметров пасеки, в настоящее время я перечисляю их в описании: измерение = m (необязательно, строка, m ) ... измерение, например. m = метры, km = километры, yd = ярды, mi = мили
4107 просмотров

Как указать атрибуты тела запроса в Apiary.io/API Blueprint?
Я пытаюсь понять, как описать/определить атрибуты/параметры тела запроса для POST/PUT. Вот пример того, что я пытаюсь сделать, но я не могу найти его нигде в документации (хотелось бы, чтобы был способ просмотреть уценку любого общедоступного...
5130 просмотров
schedule 07.02.2023

Попытка описать запрос и ответ с использованием структур данных в API Blueprint
Я пытаюсь задокументировать конечную точку с помощью API Blueprint, используя новые разделы спецификации Attributes и DataStructures. Полезная нагрузка моего запроса выглядит так: { "url": "http://requestb.in/11v7i7e1", "active": true,...
4996 просмотров
schedule 13.01.2023

JSON в схему/MSON
Я не смог найти какие-либо инструменты для этого преобразования, кто-нибудь знает какие-либо существующие. В настоящее время у меня есть данные JSON из Swagger, которые я хотел бы преобразовать в Blueprint/MSON для использования с Apiary, но я не...
1300 просмотров
schedule 11.06.2023

Указать конец группы
В примере групп https://raw.githubusercontent.com/apiaryio/api-blueprint/master/examples/04.%20Grouping%20Resources.md говорит, что конец группы обозначается началом другой группы. Есть ли способ указать конец группы без необходимости запуска...
36 просмотров
schedule 26.07.2023

Почему атрибуты в Apiary всегда отображаются в документации как обязательные, даже если они установлены как необязательные?
Я создал объект в разделе «Структуры данных» как таковой: ## User Base (object) + first_name: John (optional, string) + last_name: Doe (optional, string) + birthday: `1980-12-20` (optional, string) + email: [email protected] (optional, string) +...
192 просмотров
schedule 19.01.2023

Дополнительные примеры запроса-ответа [GET] с разными параметрами URI
У меня есть URI: /lessons/{language}/{type} Я хотел бы иметь больше фиктивных запросов-ответов с разными параметрами {язык} и {тип} в моем плане. Мне кажется, что это невозможно для метода GET. Моя идея заключается в том, что: GET...
695 просмотров

определение параметров json-сообщения на пасеке
Я пытаюсь создать документацию для проекта, используя почтовые запросы json. Теперь для запросов на получение я могу легко определить параметры uri. Однако я хочу сделать то же самое для json и других почтовых запросов. Я пробовал и хотел, чтобы...
2002 просмотров
schedule 16.01.2023

Apiary.io, тот же маршрут другим способом
Я пытаюсь определить простые маршруты CRUD в Apiary.io, но интерактивный редактор жалуется, потому что некоторые из моих маршрутов называются одинаково: /questions/{question_id} (GET) /questions/{question_id} (PUT) "Ресурс...
1153 просмотров
schedule 25.06.2023

Использование универсального именованного типа в API Blueprint на Apiary.io
Как я могу использовать общий именованный тип в моем определении API Blueprint? Я пытаюсь так: FORMAT: 1A HOST: http://test.com/ # API Blueprint testing. ## Resource [/resources] ### Action [GET] + Response 200 (application/json) +...
642 просмотров
schedule 11.04.2023

Добавление root в схему API при использовании структур данных
я часами пытался заставить это работать, читал все документы. Мне нужно, чтобы массив e имел корень (в соответствии со спецификацией json) при использовании структур данных, которые я уже определил. Что мне нужно изменить в схеме API? ТРЕБУЕТСЯ...
58 просмотров
schedule 02.08.2022

API-план, как определить конечные точки для коллекции и отдельного объекта с похожими точками
У меня есть конечная точка, которая возвращает набор контактов, и это конечная точка: .../api/v1/contact. Теперь у меня есть еще одна конечная точка, которая будет возвращать один контакт, и это конечная точка: .../api/v1/contact?Id= 68 ##...
166 просмотров
schedule 15.12.2023

Ссылка на свойство внутри определенной структуры данных в API Blueprint/MSON
Я работал с форматом API Blueprint для разработки API и получил массу удовольствия от работы с ним. Когда я объявлял свои структуры данных, я столкнулся с проблемой повторного использования кода или модели. Согласно документации при объявлении...
159 просмотров
schedule 25.06.2022