在api-blueprint服务说明中列出错误消息

时间:2019-05-24 11:26:56

标签: blueprint aglio

假设我有以下api-blueprint服务说明:

# Group Example

## GET /api/rest/Example{?p}

This service generates a unique ID.

+ Parameters

    + `p` (string, required) - some text

+ Response 200 (application/json)

    + Attributes (object)

        + `hash` (string) - hash value
        + `success` (enum[number]) - value for request
            + Members
                + `0`
                + `1`
        + `error` (number) - error number in case of unsuccessful request
        + `error_text` (string) - error message in case of unsuccessful request

我的响应中的error字段是一个介于1和2之间的数值,例如。

1 => incorrect username
2 =< incorrect password

如何在蓝图描述中列出这些错误消息?我已经尝试将错误字段定义为枚举,但是在这种情况下,只有错误号才会出现在目标HTML文件中,并且消息将被忽略。
为了渲染,我使用了aglio。

0 个答案:

没有答案