Question

最终编辑：这没有语义错误：

+ Request

    + Headers

            Accept: application/json
            Content-Type: application/json
            X-Auth-Client: Your Client Id
            X-Auth-Token: Your Token

    + Body

    + Attributes (ProductPost)


+ Response 200

    + Headers

            Content-Encoding: Entity header is used to compress the media-type.
            Content-Type: application/json
            Date: The date the response was sent.
            Transfer-Encoding: Header specifies the form of encoding used to safely transfer the entity to the user.
            Vary: HTTP response header determines how to match future request headers to decide whether a cached response can be used rather than requesting a fresh one from the origin server. We use Accept Encoding
            X-Rate-Limit-Requests-Left: Header details how many remaining requests your client can make in the current window before being rate-limited. 
            X-Rate-Limit-Requests-Quota: Header shows how many API requests are allowed in the current window for your client 
            X-Rate-Limit-Time-Reset-Ms: Header shows how many milliseconds are remaining in the window. 
            X-Rate-Limit-Time-Window-Ms: Header shows the size of your current rate-limiting window

    + Body

    + Attributes (ProductResponse)

编辑：标题部分正在渲染，但现在Body部分只显示文本“+ Attributes（ProductPost）”

+ Request

    + Headers

            Accept: application/json
            Content-Type: application/json
            X-Auth-Client: Your Client Id
            X-Auth-Token: Your Token



+ Response 200

    + Headers

            Content-Encoding: Entity header is used to compress the media-type.
            Content-Type: application/json
            Date: The date the response was sent.
            Transfer-Encoding: Header specifies the form of encoding used to safely transfer the entity to the user.
            Vary: HTTP response header determines how to match future request headers to decide whether a cached response can be used rather than requesting a fresh one from the origin server. We use Accept Encoding
            X-Rate-Limit-Requests-Left: Header details how many remaining requests your client can make in the current window before being rate-limited. 
            X-Rate-Limit-Requests-Quota: Header shows how many API requests are allowed in the current window for your client 
            X-Rate-Limit-Time-Reset-Ms: Header shows how many milliseconds are remaining in the window. 
            X-Rate-Limit-Time-Window-Ms: Header shows the size of your current rate-limiting window


    + Body

            + Attributes (ProductCollectionResponse)

我正在尝试定义Request Body并在阅读之后： https://help.apiary.io/api_101/apib-authentication/＆amp; https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md#def-headers-section

好像我可以将它们分成几个部分。但属性部分未被识别。这是一个/ GET请求。

任何想法为什么？

+ Request (application/json)

    + Headers

        + Attributes (RequestHeaders) 

    + Body

        + Attributes (ProductPost)

Answer 1

标题部分不能包含属性，您需要明确定义它们。只需替换：

    + Attributes (RequestHeaders)

定义为RequestHeaders。

还尝试在同一列对齐Body和Attributes：

+ Body
+ Attributes (ProductPost)

标题和正文下的蜂房蓝图属性无法识别

1 个答案: