Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Документирование API

Sponsored · Your Podcast. Everywhere. Effortlessly. Share. Educate. Inspire. Entertain. You do you. We'll handle the rest.

Документирование API

Avatar for Dmitry Efimov

Dmitry Efimov

March 30, 2016
Tweet

More Decks by Dmitry Efimov

Other Decks in Programming

Transcript

  1. # Клиент # Ошибка в синтаксисе запроса # Создание пользователя

    # # @note заметка # # @param [User] user пользователь # # @raise [Client::BadRequest] ошибка в синтаксисе запроса # # @return [User] пользователь
  2. # @note Если не помещается, можно # продолжить писать на

    другой строке # @note если требуется что то перечислить # - можно # - сделать # - список
  3. resource_description do name "Аутентификация" end api! 'Вход в систему' param

    :login, String, required: true, desc: "Логин пользователя" param :password, String, required: true, desc: "Пароль пользователя" error 401, "Ошибка в логине или пароле" example 'можно написать пример тела запроса или ответа'