Question

在为休息服务编写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][]

我需要像参数部分的“值”这样的东西，但是Body部分需要在Body部分描述状态，例如。

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

Answer 1

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

Blueprint API显示响应正文中Enum的所有可能值

1 个答案: