Upgrade to Pro — share decks privately, control downloads, hide ads and more …
Sign up for free

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

Avatar for Dmitry Efimov Dmitry Efimov
March 30, 2016
Programming
200
0

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

Avatar for Dmitry Efimov

Dmitry Efimov

March 30, 2016

More Decks by Dmitry Efimov

See All by Dmitry Efimov
Автоматизируем синхронизацию HTTP API и документации
Avatar for Dmitry Efimov tuwilof
0
52
Автоматизация Document-Driven Development для проектов с большим API
Avatar for Dmitry Efimov tuwilof
0
52
Инструменты для обнаружения рассинхронизации реализации “REST” API от документации
Avatar for Dmitry Efimov tuwilof
0
58
Валидация “REST” API по документации APIB
Avatar for Dmitry Efimov tuwilof
0
51
Негативное тестирование “REST” API и защита от него
Avatar for Dmitry Efimov tuwilof
0
350
Ликбез по JSON
Avatar for Dmitry Efimov tuwilof
0
94
API Blueprint
Avatar for Dmitry Efimov tuwilof
0
89
Почему и как заменить все id на UUID
Avatar for Dmitry Efimov tuwilof
0
110
Authentication in rails. Monolith vs SPA
Avatar for Dmitry Efimov tuwilof
0
220

Other Decks in Programming

See All in Programming
Unity6 URPによる海底をテーマにしたVJシステムの解説 | Unity Shader 完全に理解した 勉強会
Avatar for がむ gam0022
0
370
自サークルのIdPからログアウトできるようになるまで
Avatar for taiseiue taiseiue
1
140
golang-bob.pdf
Avatar for Yura Iwatsuka iwatsukayura
0
130
TechTown - Creating Composable Callables in Contemporary C++
Avatar for Björn Fahller rollbear
0
130
dotNET_vulnclicker_intro.pdf
Avatar for Tomohiko Morita deka_morita
0
140
AIで開発が速くなった先で、開発チームは何を目指すか
Avatar for Yuki Shiho shihochan
0
1k
iOS 27でニュースアプリはどう変わる！？ 〜日経電子版の新機能対応と、開発事例から〜
Avatar for Kazuki Nakashima lynnswap
7
13k
半永久的に提供し続けられるプライベートクラウドを目指して ― 利用者の認知負荷を抑えるAPI抽象化とハードウェア世代交代の基盤設計
Avatar for Tomofumi Kondo tomokon
0
500
なぜCTOを降りてFDEを選んだのか？〜なぜプロダクト企業がFDEで顧客の現場に踏み込むのか〜
Avatar for ryuta sakamoto gonta
1
210
RAG の “R” を Swift で覗いてみる 〜「意味から探す」検索の仕組み〜
Avatar for Nao-RandD nao_randd
0
160
作れる、でも消せるか？──安全に「枯らして消す」機能削除術 / Drain, Then Delete
Avatar for chobishiba chobishiba
2
640
HTML-in-Canvasで作る未来のWeb UI表現
Avatar for IKEDA Yasunobu clockmaker
5
5.1k

Featured

See All Featured
Mobile First: as difficult as doing things right
Avatar for Swwweet swwweet
225
10k
Connecting the Dots Between Site Speed, User Experience & Your Business [WebExpo 2025]
Avatar for Tammy Everts tammyeverts
11
1.1k
Neural Spatial Audio Processing for Sound Field Analysis and Control
Avatar for NII S. Koyama's Lab skoyamalab
0
570
Technical Leadership for Architectural Decision Making
Avatar for Kenny Baas-Schwegler baasie
3
600
Context Engineering - Making Every Token Count
Avatar for Addy Osmani addyosmani
9
1.2k
The SEO identity crisis: Don't let AI make you average
Avatar for Varn varn
0
590
Put a Button on it: Removing Barriers to Going Fast.
Avatar for kastner kastner
60
4.6k
For a Future-Friendly Web
Avatar for Brad Frost brad_frost
184
10k
Site-Speed That Sticks
Avatar for Harry Roberts csswizardry
13
1.6k
Cheating the UX When There Is Nothing More to Optimize - PixelPioneers
Avatar for Stéphanie Walter stephaniewalter
287
14k
Rails Girls Zürich Keynote
Avatar for Gregor Martynus gr2m
96
14k
Building an army of robots
Avatar for Kyle Neath kneath
307
47k

Transcript

  1. None
  2. None
  3. None
  4. None

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

    # # @note заметка # # @param [User] user пользователь # # @raise [Client::BadRequest] ошибка в синтаксисе запроса # # @return [User] пользователь

  6. # @note Если не помещается, можно # продолжить писать на

    другой строке # @note если требуется что то перечислить # - можно # - сделать # - список

  7. yard server --reload http://localhost:8808/

  8. None
  9. None

  10. resource_description do name "Аутентификация" end api! 'Вход в систему' param

    :login, String, required: true, desc: "Логин пользователя" param :password, String, required: true, desc: "Пароль пользователя" error 401, "Ошибка в логине или пароле" example 'можно написать пример тела запроса или ответа'
  11. None
  12. None
  13. None
  14. None
  15. None
  16. None
  17. None
  18. None
  19. None
  20. None
  21. None
  22. None
  23. None
  24. None
  25. None
  26. None

  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