Различные версии API Blueprint

Question

Структура к примеру на http://apiblueprint.org/#get-started кажется отличной от структуры на APIary.io.

Может кто-нибудь прокомментировать, являются ли они разными, и если да, то какая структура правильная?

Например,

API Чертеж документа Структура

1.) Метаданные 2. API) Имя & Обзор 3.) Ресурс А.) URI Параметры B.) Модель 1.) Заголовки 2.) Тело 3.) Схема C.) Действие 1.) URI Параметры 2.) Запрос а.) Заголовки б.) Кузов с.) Схема 3.) Ответ а.) Заголовки б.) Тело гр.) Схема 4.) Группа ресурсов A.) Ресурс

против

{ 
    "_version": "2.0", 
    "metadata": [], 
    "name": "", 
    "description": "", 
    "resourceGroups": [ 
     { 
      "name": "", 
      "description": "", 
      "resources": [ 
       { 
        "name": "", 
        "description": "", 
        "uriTemplate": "/message", 
        "model": {}, 
        "parameters": [], 
        "actions": [ 
         { 
          "name": "", 
          "description": "", 
          "method": "GET", 
          "parameters": [], 
          "examples": [ 
           { 
            "name": "", 
            "description": "", 
            "requests": [], 
            "responses": [ 
             { 
              "name": "200", 
              "description": "", 
              "headers": [ 
               { 
                "name": "Content-Type", 
                "value": "text/plain" 
               } 
              ], 
              "body": "Hello World!\n", 
              "schema": "" 
             } 
            ] 
           } 
          ] 
         } 
        ] 
       } 
      ] 
     } 
    ] 
} 

Большое спасибо ,

Answer 1

«Структура документа API Blueprint», о которой вы упомянули, - это то, как вы пишете документ API Blueprint.

JSON, который вы написали выше, является AST, который вы получаете при анализе вышеуказанного API Blueprint с использованием анализатора API Blueprint, такого как https://github.com/apiaryio/snowcrash.

Итак, оба они представляют ваш API Blueprint правильно, но не-АСТ один гораздо читабельнее.

Надеюсь, что очистит ваше замешательство.