Api Blueprint MSON 中是否有类似 excel table 的任何 json 架构?
Is there any json schema like a excel table in Api Blueprint MSON?
在 Api Blueprint MSON 中是否有类似 excel table 的任何 json 模式?
我正在几个客户之间设计一些 api。
所以我需要 api 可以以易于阅读的格式呈现的文档工具。
我搜索这 3 个解决方案。 (Swagger、RAML、Api 蓝图)。
我决定 Api Blueprint 因为它可以用 markdown 呈现更丰富的形式。
Api Blueprint 中的几乎每个功能都让我满意。
但是 json 模式格式非常复杂且难以阅读。
我希望我的结果 html 最后像下面这样。
(我使用 aglio 作为 Api 蓝图 html 渲染器。)
这是我的 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
Aglio 目前不支持此功能。您可以编写自定义主题布局或主题引擎来支持这一点。
在 Api Blueprint MSON 中是否有类似 excel table 的任何 json 模式?
我正在几个客户之间设计一些 api。 所以我需要 api 可以以易于阅读的格式呈现的文档工具。 我搜索这 3 个解决方案。 (Swagger、RAML、Api 蓝图)。 我决定 Api Blueprint 因为它可以用 markdown 呈现更丰富的形式。 Api Blueprint 中的几乎每个功能都让我满意。 但是 json 模式格式非常复杂且难以阅读。 我希望我的结果 html 最后像下面这样。 (我使用 aglio 作为 Api 蓝图 html 渲染器。)
这是我的 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
Aglio 目前不支持此功能。您可以编写自定义主题布局或主题引擎来支持这一点。