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

Квадратные скобки в имени параметра
Мне было интересно, можно ли включить квадратные скобки в имя параметра, как Rails группирует параметры. Например: + Parameters + person[age] (string) ... Person's age Прямо сейчас, если я включу квадратную скобку, параметр не...
1158 просмотров
schedule 28.05.2024

Как я могу использовать пасеку с JSON-RPC
Я пытаюсь использовать apiary.io для документирования API на основе JSON-RPC. Я могу отформатировать страницы, но консоль просто не работает. С JSON-RPC у вас обычно есть только 1 URI, как в случае с нашим API. Из-за этого при попытке определения...
750 просмотров
schedule 13.04.2024

что такое чванство именно? А почему онлайн-редактор не запускает запросы?
Я провел последние несколько дней, пытаясь понять, следует ли мне использовать план API, RAML или чванство. Похоже, у swagger самое большое сообщество, но чем ближе я смотрю, тем больше я чувствую, что ему сильно не хватает документации (мне...
2289 просмотров
schedule 10.01.2024

Инструмент документации API BluePrint
Я новичок в этом инструменте API Blueprint. Может ли кто-нибудь объяснить мне, как использовать этот инструмент для захвата всех моих API веб-сервисов Restful с помощью API Blueprint, как это (...
132 просмотров
schedule 25.10.2022

Как один раз указать Content-Type всех ответов в API Blueprint?
Чтобы удовлетворить Дредда, я должен написать это для каждого ответа в моем документе API Blueprint: + Response 201 (application/json; charset=utf-8) Есть ли способ указать тип носителя ( (application/json; charset=utf-8) ) один раз глобально...
237 просмотров
schedule 09.06.2024

Как указать пример для типа объекта в API-Blueprint
Можно ли указать примерное значение для «bar» в типе Baz в следующей структуре данных? # Data Structures ## Foo (object) + arg0 (number, required) - the arg0 + arg1 (number, optional) - the arg1 + arg2: a, b, c (enum, required) - the...
83 просмотров
schedule 06.02.2024

Как переопределить значения образца MSON
Если я определяю тип ресурса с образцами значений, как я могу переопределить их для конкретных примеров? Я пробовал это, но визуализированный вывод игнорирует тело и вместо этого использует глобальный образец. ### Read item [GET] + Response...
643 просмотров
schedule 28.10.2023

Дредд/пасека/массив MSON любого размера
мы изо всех сил пытаемся описать массив любого размера в нашем API. Использование API Blueprint и формата MSON для тестирования Dredd. Конечная точка /spots должна возвращать массив «Spots» (это объекты). Хотя мы не знаем, сколько. В настоящее...
200 просмотров
schedule 30.10.2022