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

Transcript

5. # Клиент # Ошибка в синтаксисе запроса # Создание пользователя # # @note заметка # # @param [User] user пользователь # # @raise [Client::BadRequest] ошибка в синтаксисе запроса # # @return [User] пользователь
6. # @note Если не помещается, можно # продолжить писать на другой строке # @note если требуется что то перечислить # - можно # - сделать # - список
7. yard server --reload http://localhost:8808/
10. resource_description do name "Аутентификация" end api! 'Вход в систему' param :login, String, required: true, desc: "Логин пользователя" param :password, String, required: true, desc: "Пароль пользователя" error 401, "Ошибка в логине или пароле" example 'можно написать пример тела запроса или ответа'
27. https://apiblueprint.org/tools.html https://github.com/kylef/apiblueprint.vim https://atom.io/packages/api-blueprint-preview https://atom.io/packages/language-api-blueprint
28. http://yardoc.org/ https://github.com/lsegal/yard https://github.com/Apipie/apipie-rails https://apiary.io/ https://apiblueprint.org https://github.com/apiaryio/mson https://help.apiary.io/api_101/ https://apiblueprint.org/documentation/specification.html