API蓝图架构使用方法

Question

我们希望使用API蓝图和模式。例如，我们想要指定PUT到资源中接受有效载荷中的账户，GET在同一资源上返回一个账户有效载荷。因此，我需要指定在GET和PUT请求中使用账户，并且需要指定账户本身。我不知道在哪里指定它，有没有规范的方法？不幸的是，在示例中我找不到这方面的信息。

- user2790329

Answer 1

在多个操作中重复使用一个消息载荷，可以利用资源模型的概念。

只需定义一个账户模型，然后稍后就可以像这样重复使用它：

# Account [/account]

+ Model (application/json)
    + Body

            { ... }

    + Schema

            { ... }

## Retrieve an Account [GET]

+ Response 200

    [Account][]


## Update an Account [PUT]

+ Request

    [Account][]

+ Response 204

- Zdenek