Документировать альтернативные органы запроса

Question

API, который мы создаем, позволяет пользователю предоставлять различные тела запросов. Из того, что я видел / нашел до сих пор, можно предоставить только один запрос на действие / ресурс. Можно ли как-то указать разные тела запроса?

Я попробовал это так:

### 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

Вы можете иметь несколько запросов и ответов в одном действии. Пожалуйста, смотрите пример ниже.

### 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