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

API Blueprint is a Markdown-based DSL for describing HTTP APIs.
1 ответ

Обеспечивают ли IBM Bluemix и Azure равную поддержку API Blueprint и OpenAPI? Для описания API

Я мог бы помочь, решив, какой язык описания API использовать для API, которые наша команда развернула в IBM Cloud и, возможно, Azure в будущем. Мы неофициально использовали API Blueprint, но при регистрации API в Bluemix я заметил, что (и Azure) уже…
11 апр '18 в 22:13
1 ответ

Структуры apiblueprint для достижения желаемого описания

В настоящее время у меня есть такой план API, но я не могу добиться правильного рендеринга. FORMAT: 1A HOST: http://polls.apiblueprint.org/ # Samwise Web API This document describes Samwise system WebAPI. Developers should refer to [this reference](…
24 апр '15 в 13:09
1 ответ

Как синхронизировать API Blueprint с исходным кодом API?

Я хочу разработать REST Full API с использованием PHP. Но прежде чем приступить к разработке настоящего API, я хочу сначала создать Blueprint в виде документации с консолью API, скажем, я использую для этого swagger или raml. Как я понимаю, API Blue…
16 мар '16 в 07:46
2 ответа

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

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

Учитывая модель ресурса проекта API, как я могу гарантировать, что только для чтения часть ресурса не обновляется?

У меня есть большая модель, которую я использую как для GET, так и для PUT на ресурсе. Модель включает в себя объект "аудита", например: "audit": { "createdAt": "2014-04-14T02:15:15Z", "lastUpdatedAt": "2014-04-14T02:15:15Z", "deletedAt": "" } Это, …
02 июл '14 в 00:36
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 ответ

API Facebook в машиночитаемом формате

Где я могу найти API Facebook в таком формате, как http://swagger.io/, https://apiblueprint.org/ или http://raml.org/? Я хочу прочитать и запросить сервер facebook (api) "полуавтоматический". Мой скрипт знает, как взаимодействовать с сервером Facebo…
11 фев '15 в 19:46
1 ответ

Как переопределить значения примеров MSON

Если я определяю тип ресурса с примерами значений, как я могу переопределить их для конкретных примеров? Я попробовал это, но обработанный вывод игнорирует Body и вместо этого использует глобальный Sample. ### Read item [GET] + Response 200 + Attrib…
01 фев '17 в 17:49
0 ответов

Api Blueprint использует Body и Attributes вместе, но сохраняет указанный JSON Body

У меня есть такой файл apib, и я хочу, чтобы тело ответа отображалось вместо сгенерированного тела из Attributes (SearchResult) но я не могу удалить Attributes (SearchResult) потому что я хочу сохранить сгенерированную схему от Attributes (SearchRes…
17 окт '18 в 05:29
1 ответ

Опустить свойство объекта, определенного в MSON

Как я могу пропустить свойство из определенного MSON? Я определил одну простую сущность (объект), используя MSON: # Data Structures ## Article (object) Represents an article ## Properties + id: 1 (number, optional) + name: My first article (string) …
12 июн '16 в 15:12
1 ответ

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

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

Документирование параметров запроса с помощью API Blueprint

Я пытаюсь задокументировать параметр запроса в API Blueprint, но я не совсем уверен, правильно ли я это сделал. Ресурс выглядит так: DELETE http://baasar.apiary-mock.com/user/{appId}/{userId} Этот запрос будет деактивировать пользователя, в то время…
03 апр '14 в 18:12
1 ответ

Как отформатировать POST-запрос на apiary.io?

Спасибо за ваше время у меня есть запрос POST, который я хочу документировать на пасеке проекта, заголовок выглядит примерно так: текст / html _method: POST Данные [Пользователь] [имя пользователя]: Данные [Пользователь] [пароль]: Данные [Пользовате…
07 ноя '13 в 15:57
1 ответ

"Неизвестный тип посетителя" в пакете npm, главный герой

Я пытаюсь преобразовать свои API Blueprints в коллекцию Postman через protagonist (а затем через blueman), но когда я использую главного героя, я получаю следующий результат, независимо от того, что я делаю. { "element": "parseResult", "content": [ …
01 апр '16 в 14:59
1 ответ

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

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

Как сделать перечисления в API Blueprint сухими

Я документирую API, используя API Blueprint, и у меня есть несколько конечных точек, которые используют один и тот же тип enum с одинаковыми значениями. Вместо того, чтобы повторять все значения в каждой точке, где используется это перечисление, я х…
06 апр '17 в 00:28
1 ответ

Не удается установить пакет атомов api-blueprint-preview

Я установил Python, npm (все добавлено в путь), VS 2013 и попытался установить пакет Atom под названием api-blueprint-preview. PS X:\> apm install api-blueprint-preview Installing api-blueprint-preview to C:\Users\mm\.atom\packages failed runas@1…
17 фев '15 в 15:58
1 ответ

В чем разница между весной и планом и маршрутизатором в Apache Camel?

Я новичок в плавком предохранителе. Я использую Jboss Fuse и создаю проект Fuse. Я хочу знать основные различия между контейнером, таким как весна, проект и маршрутизатор?
1 ответ

Документировать альтернативные органы запроса

API, который мы создаем, позволяет пользователю предоставлять различные тела запросов. Из того, что я видел / нашел до сих пор, можно предоставить только один запрос на действие / ресурс. Можно ли как-то указать разные тела запроса? Я попробовал это…
22 июл '14 в 08:51