养蜂场:忽略无法识别的块

apiary: Ignoring unrecognized block

我在 apiary 中为 post 访问权限的服务定义了以下内容:

## Access Right [/api/v0.3/accessrights/{id}/assign?isExternalKey=true]

### Assign access rights [Post]            

+ accessRightId (number)
+ personId (string)

+ Parameters
    + id (number) - ID of the Access Right in the form of an integer

+ Request (application/json)

            {
                "personId": "785"
            }

+ Response 201

Apiary 告诉我无法识别请求和响应块。我尝试制作必填字段,制作必填参数,更改字段的拼写,删除 (application/json),修改间距。似乎没有任何帮助。 请求和响应块有什么问题?

通过切换块的顺序(从参数、请求、响应到请求、响应、参数),识别请求和响应主体:

## Access Right [/api/v0.3/accessrights/{id}/assign?isExternalKey=true]

### Assign access rights [Post]            

+ accessRightId (number)
+ personId (string)

+ Request (application/json)

            {
                "personId": "785"
            }

+ Response 201

+ Parameters
    + id (number) - ID of the Access Right in the form of an integer

我不确定为什么这很重要,但至少现在 API 验证为有效 API 蓝图。 问题解决了!

方法名称必须全部大写,如规范和网络中所述。

因此,"Assign access rights"行应该写成:

### Assign access rights [POST]