API蓝图架构用法

时间:2013-09-18 13:48:08

标签: rest documentation apiblueprint

我们希望将API blueprint与架构一起使用。假设我们要指定资源的PUT接受有效负载中的Account,而同一资源上的GET返回Account负载。所以我需要指定在GET和PUT中使用Account,我需要指定Account本身。我不知道在哪里指定它,什么是规范的方式?不幸的是,我无法在示例中找到它。

1 个答案:

答案 0 :(得分:4)

在多个操作中重用一个消息有效负载可以使用resource model的概念。

只需定义一个帐户模型,然后再重复使用它:

# Account [/account]

+ Model (application/json)
    + Body

            { ... }

    + Schema

            { ... }

## Retrieve an Account [GET]

+ Response 200

    [Account][]


## Update an Account [PUT]

+ Request

    [Account][]

+ Response 204