rest - API 蓝图架构使用

Question

我们希望将API 蓝图与模式一起使用。比方说，我们要指定对资源的 PUT 接受负载中的 Account 并且在同一资源上的 GET 返回一个 Account 负载。所以我需要指定在 GET 和 PUT 中使用 Account 并且我需要指定 Account 本身。我不知道在哪里指定它，规范的方式是什么？不幸的是，我无法在示例中找到它。

Answer 1

在多个操作中重用一个消息有效负载是可以利用资源模型概念的地方。

只需定义一个帐户模型，然后像这样重用它：

# Account [/account]

+ Model (application/json)
    + Body

            { ... }

    + Schema

            { ... }

## Retrieve an Account [GET]

+ Response 200

    [Account][]


## Update an Account [PUT]

+ Request

    [Account][]

+ Response 204