apiblueprint - 代替リクエスト本文の文書化

Question

私たちが構築している API を使用すると、ユーザーはさまざまなリクエスト ボディを提供できます。私がこれまでに見たり見つけたりしたことから、アクション/リソースごとに 1 つのリクエストしか提供できません。どういうわけか異なるリクエストボディを指定することは可能ですか?

私はそれを次のように試しました：

### Create new line item for an existing order [POST]

Some description

+ Request (application/json)

### Create new line item and order [POST]

Some other description

+ Request (application/json)

また、好きです：

### Create new line item for an existing order [POST]

Some description

+ Request (application/json)
+ Request (application/json)

Answer 1

1 つのアクションで複数の要求と応答を行うことができます。以下の例を参照してください。

### Create new line item for an existing order [POST]

Some description

+ Request (application/json)
+ Response 200

+ Request (application/json)
+ Response 404

+ Request (application/xml)
+ Request (application/json)
+ Response 200