Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Sign up for free
Menu
Search
Features
All features
Private URLs
Password Protection
Custom URLS
Scheduled publishing
Remove Branding
Restrict embedding
Deck Collections
Notes
Features
All features
Private URLs
Password Protection
Custom URLS
Scheduled publishing
Remove Branding
Restrict embedding
Deck Collections
Notes
Explore
Featured decks
Featured speakers
Programming
Technology
Storyboards
Explore
Featured decks
Featured speakers
Programming
Technology
Storyboards
Pricing
Search
Sign in
Sign up for free
Документирование API
Search
Sponsored
·
SiteGround - Reliable hosting with speed, security, and support you can count on.
→
Dmitry Efimov
March 30, 2016
Programming
210
0
Share
Embed
Copy iframe code
Copy JS code
Copy link
Start on current slide
Документирование API
Dmitry Efimov
March 30, 2016
Transcript
28 slides
None
None
None
None
# Клиент # Ошибка в синтаксисе запроса # Создание пользователя
# # @note заметка # # @param [User] user пользователь # # @raise [Client::BadRequest] ошибка в синтаксисе запроса # # @return [User] пользователь
# @note Если не помещается, можно # продолжить писать на
другой строке # @note если требуется что то перечислить # - можно # - сделать # - список
yard server --reload http://localhost:8808/
None
None
resource_description do name "Аутентификация" end api! 'Вход в систему' param
:login, String, required: true, desc: "Логин пользователя" param :password, String, required: true, desc: "Пароль пользователя" error 401, "Ошибка в логине или пароле" example 'можно написать пример тела запроса или ответа'
None
None
None
None
None
None
None
None
None
None
None
None
None
None
None
None
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
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
More Decks by Dmitry Efimov
See All by Dmitry Efimov
Автоматизируем синхронизацию HTTP API и документации
tuwilof
0
55
Автоматизация Document-Driven Development для проектов с большим API
tuwilof
0
55
Инструменты для обнаружения рассинхронизации реализации “REST” API от документации
tuwilof
0
62
Валидация “REST” API по документации APIB
tuwilof
0
70
Негативное тестирование “REST” API и защита от него
tuwilof
0
350
Ликбез по JSON
tuwilof
0
98
API Blueprint
tuwilof
0
93
Почему и как заменить все id на UUID
tuwilof
0
110
Authentication in rails. Monolith vs SPA
tuwilof
0
220
Other Decks in Programming
See All in Programming
クラウドエージェントは、 何がそんなに便利なのか / what makes cloud agents so useful
rkaga
5
980
手の動かし方がわからなかった私が個人開発者になるまで
usagi0920_pochi
0
340
数行の変更でDockerビルドを最大91%高速化~GitLab CIの実行基盤を社内40リポジトリに展開するまで~
picopico
2
260
眠らない開発チームの作り方
biwakonbu
0
100
Growing PicoRuby's Ecosystem on ESP32
yuuu
2
150
AIコーディングをセッションで終わらせない: PHPライブラリ開発におけるコンテキスト承継設計
ickx
0
110
Agentic AI with the Power of Jakarta EE
ivargrimstad
0
180
エラーチャンネルのボールを拾い続けて鍛えるエンジニアの地力 / phpcon-niigata2026
meihei3
1
500
protojson における文字化けの扱い
kazuki1023
0
460
Debian JP Projectのサーバー構成
uwabami
1
180
祈るテストから、探索するテストへ 〜Lincheckではじめる並行処理テスト〜
yyh_gl
0
430
Augmenting AI with the Power of Jakarta EE
ivargrimstad
0
420
Featured
See All Featured
The Success of Rails: Ensuring Growth for the Next 100 Years
eileencodes
47
8.4k
Lightning Talk: Beautiful Slides for Beginners
inesmontani
PRO
2
860
10 Git Anti Patterns You Should be Aware of
lemiorhan
PRO
659
62k
The SEO Collaboration Effect
kristinabergwall1
1
630
How to make the Groovebox
asonas
2
2.6k
YesSQL, Process and Tooling at Scale
rocio
174
15k
Design and Strategy: How to Deal with People Who Don’t "Get" Design
morganepeng
133
20k
Heart Work Chapter 1 - Part 1
lfama
PRO
11
37k
Let's Do A Bunch of Simple Stuff to Make Websites Faster
chriscoyier
508
140k
Java REST API Framework Comparison - PWX 2021
mraible
34
9.8k
Introduction to Domain-Driven Design and Collaborative software design
baasie
1
1.1k
Designing Experiences People Love
moore
143
24k