3

在为休息服务编写 API-Deocumentation 时，我遇到了一个问题，我想列出所有可能作为响应返回的值。

在下面的情况下，它将是“状态”字段，它可以包含任何可能的枚举值，我想总结一下存在哪些可能的状态。

我找不到使用 apiblueprint 的简单好方法。有没有办法显示默认折叠的部分并在需要其他信息时展开它们？

这是我的示例代码：

## Sample [/Sample?{id}]
Get all the information for the sample

+ Parameters
   + id = `0` (Integer, optional) ... The Id of the resource to get

+ Model (application/json)

  + Body

            {
                "name": "Name of the Resource",
                "state": "deleted"
            }

### Retrieve the sample data of the system [GET]
+ Response 200
  [ProviderConfiguration][]

我需要参数部分的“值”之类的东西，但身体部分需要描述身体部分中的状态，例如

<collapsible>   
+ state (EnumType) ... current state of the sample object
  + Values
     + `active`
     + `inactive`
     + `deleted`
</collapsible>
4

1 回答 1

2

不幸的是，这在 API Blueprint 中尚无法实现。但是，这是计划好的 - 请参阅https://github.com/apiaryio/api-blueprint/issues/25和https://github.com/apiaryio/mson。

于 2014-07-14T09:19:21.050 回答