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

Описание тега Вопросы с тегом
Синтаксис Markdown для объектной нотации (MSON)
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 mson объект с разными значениями

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

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

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

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
0 ответов

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

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

Параметризация структуры данных в API-проекте

Я смутно имею следующий документ: # Group Cats ## Get ALl The Cats [GET /api/v1/cats{?page%5bsize%5d,page%5bnumber%5d,sort,filter}] + Parameters + page%5bsize%5d: 10 (number, optional) - Maximum number of resources in a single paginated response. + …
24 сен '18 в 10:07
1 ответ

Обтекание структуры данных в ключе данных API Blueprint / Apiary

Так скажем, у меня есть 200 ответ какой орган должен быть: { "data": [ { "id": 1, "title": "Activity 1" }, { "id": 1, "title": "Activity 2" } ] } Мне удалось получить такое поведение тела ответа, используя это в API Blueprint. + Response 200 (applic…
11 мар '17 в 20:06
1 ответ

Попытка описать запрос и ответ с использованием структур данных в API Blueprint

Я пытаюсь задокументировать конечную точку с помощью API Blueprint, используя новые разделы Attributes и DataStructures спецификации. Полезная нагрузка моего запроса выглядит следующим образом: { "url": "http://requestb.in/11v7i7e1", "active": true,…
22 апр '15 в 23:31
1 ответ

Использовать шаблон в API Blueprint / MSON

Я исследую возможности нового синтаксиса Data Structures в API Blueprint, особенно в MSON. Можно ли прикрепить или точнее указать что-то вроде шаблона (регулярное выражение)? Ничего не нашел по этой теме.
05 авг '15 в 11:13
1 ответ

Ошибка объекта массива MSON в проекте API Blueprint

Мы разрабатываем новый API с использованием HAL+JSON, используя API Blueprint Apiary.io. Мы использовали JSON в наших ответах в рамках самого Blueprint. Я тестирую переход на использование MSON вместо этого, но у меня проблема с объектом массива. Во…
15 авг '15 в 18:59
0 ответов

Как ссылаться на значение перечисления в API Blueprint(MSON)

Я использую API Blueprint и Agilo для отображения документации по API. При использовании типа enum я наблюдаю странное поведение. Ответ не отображается с определенным значением перечисления, тогда как схема показывает все значения перечисления (что …
17 янв '19 в 09:41
1 ответ

Свойство смешанного API Blueprint / MSON

Я пытаюсь создать объект структуры данных. Есть два возможных значения одного из его свойств, но они имеют смешанный тип. Иногда это может быть число, но иногда это может быть массив строк. {"collectorNo": 285} {"collectorNo": ["60a", "60b"]} Я дума…
07 авг '16 в 14:35
1 ответ

План API потерпел неудачу с Dredd на API в реальном времени?

Я нахожусь в процессе обновления dredd с 1.08 до последней версии, в то время как в нем я пытаюсь проверить нашу документацию API, написанную в виде чертежа с тестовым API в реальном времени, и она терпит неудачу. Поскольку тесты выполняются для API…
17 ноя '17 в 11:59
1 ответ

Как определить пример значений массива ApiBlueprint с помощью MSON?

Могу ли я использовать MSON для указания значений примера вместо + Body? Можно ли переопределить предопределенные значения структуры? Я пытался так: + Request (application/json) + Headers Authorization: JWT <token> + Attributes (ClientsideComm…
08 ноя '17 в 13:04
2 ответа

Вложенный массив с объектом в MSON пуст в документации Apiary.io

Я хотел бы создать вложенный массив с объектами в формате MSON для использования с API Blueprint и Apiary. Код выглядит корректно, но при рендеринге в пасеке я не получаю ожидаемый JSON. Пример, который я хочу создать: у навигации есть несколько кат…
17 июн '15 в 11:58
1 ответ

Как я могу определить массив перечислений в проекте API

Мое предполагаемое решение для раздела параметров + fields: [firstField, secondField] (array[enum], optional) + Members + firstField + secondField + extraField + dummyField Но это не удалось из-за семантической ошибки: Пример значения [firstField, s…
07 сен '15 в 14:36
1 ответ

API план MSON для определения допустимых значений атрибутов?

Посмотрите на этот отрывок из https://github.com/apiaryio/mson... Пример 1 Просто object структура и связанное с ней выражение JSON.MSON - id: 1 - name: A green door - price: 12.50 - tags: home, green Допустим, я хотел бы определить допустимые значе…
31 мар '16 в 22:00
1 ответ

Примитивный тип как структура данных для API Blueprint

Я хочу использовать примитивный тип для описания структуры данных. Вот так: # Data Structures ## Video Delete (enum[number]) + `0` - Successful deletion. + `1` - Error occured. И вывод есть. { "enum": [ 1, 0 ], "$schema": "http://json-schema.org/dra…
14 ноя '15 в 16:17
1 ответ

MSON для описания атрибутов объекта в проекте

У меня есть проблема, похожая на то, что описано здесь. У меня есть JSON, который выглядит так: { "photos": [ { "key": "y37dmj10jkwof/moOIUB8912JKVgh", "caption": "A world of gamers.", "tags": [ "game", "japan" ], "attributes": { "copyright": true, …
31 июл '15 в 18:07