Как указать коды ошибок в документации Apiary?

Я хочу указать различные исключения/ошибки, которые должны быть возвращены при вызове API. Как мне добиться этого с помощью Пасека.

Ответ 1

Кайл-ответ действительно правильный. Я просто добавлю, что если вы хотите добавить немного больше семантики к этому, вы можете написать другие возможные ответы следующим образом:

## POST /users/resendVerification/{userId}

Resends the user verification code to the email address on record.

+ Response 201

+ Response 403

    Returned if the user does not have access to the requested account

    + Body

+ Response 404

    Returned if a user was not found for the given userId

    + Body

Примечание. Для отличия описания от тела сообщения требуется + Body (даже если он пуст).

Ответ 2

Я не знаю конкретного синтаксиса для кодов ошибок. Раньше я просто использовал пулевые очки. Например, это мой код для API кода запроса повторного запроса.

## POST /users/resendVerification/{userId}

Resends the user verification code to the email address on record.</br>
• 403 is returned if the user does not have access to the requested account</br>
• 404 is returned if a user was not found for the given userId</br>

+ Response 201

Надеюсь, что это поможет.