2017-03-13 12 views
0

Api Blueprint MSONにExcelテーブルのようなjsonスキーマはありますか?Api Blueprint MSONにExcelテーブルのようなjsonスキーマはありますか?

私はいくつかのクライアントの間にいくつかのAPIを設計しています。 だから私は簡単に判読可能な形式で表示することができるAPIのドキュメントツールが必要です。 これらの3つのソリューションを検索します。 (スガッガー、RAML、Api Blueprint)。 私はApi Blueprintを決定しました。これは、Markdownでより豊かなフォームを提示できるからです。 Api Blueprintのほぼすべての機能が私を満足させました。 しかし、jsonスキーマ形式は複雑で読みにくいです。 私は最終的に以下のように私の結果のHTMLをしたい。 (Iは、APIの青写真のHTMLレンダリングとしてaglioを使用。)

これはこれは、現在Aglioでサポートされていない私のAPIBソースコード

FORMAT: 1A 



# GET /MyApi 

- Request 
    - Attributes 
     - name : hhd (string, required) - this is person name 
     - age : 37 (number, optional) - this is person age 
     - pets (array) 
      - (object) 
       - name : tom (string, optional) - this is pet's name 
       - type : dog (string, required) - this is pet's type 
      - (object) 
       - name : jane 
       - type : cat 


- Response 200 
    - Attributes 
     - status : ok (string, required) 
     - id : 1000 (number, required) 
     - name : hhd (string, required) - this is person name 
     - age : 37 (number, optional) - this is person age 
     - pets : (array) 
      - (object) 
       - id : 10001 (number, required) 
       - name : tom (string, optional) - this is pet's name 
       - type : dog (string, required) - this is pet's type 
      - (object) 
       - id : 10002 
       - name : jane 
       - type : cat 

答えて

1

です。これをサポートするカスタムテーマレイアウトやテーマエンジンを書くことができます。