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
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
52
Автоматизация Document-Driven Development для проектов с большим API
tuwilof
0
55
Инструменты для обнаружения рассинхронизации реализации “REST” API от документации
tuwilof
0
61
Валидация “REST” API по документации APIB
tuwilof
0
65
Негативное тестирование “REST” API и защита от него
tuwilof
0
350
Ликбез по JSON
tuwilof
0
94
API Blueprint
tuwilof
0
89
Почему и как заменить все id на UUID
tuwilof
0
110
Authentication in rails. Monolith vs SPA
tuwilof
0
220
Other Decks in Programming
See All in Programming
Python Lambdaにおけるテストしやすい設計とAI支援の活用 / Designing Testable Python Lambda Functions with AI
kitano_yuichi
1
320
エージェントを使い続けるためのメタワーク / Meta-work for keeping using the agent
rkaga
6
2.3k
Vue.jsで作る空間解析アプリとCapacitorプラグインのData Bridge
hal_spidernight
1
170
オーケストレーション記述言語 Katari
yukikurage
0
260
Goコンパイラを作ってGoをもっと理解する / Build a Go compiler to better understand Go
ikura_hamu
0
130
Optunaを作ったときにやりたかったこと、その後 (2026/10/16, Optuna Meetup #3)
iwiwi
4
1.5k
baseline으로 마이그레이션, 리팩토링 안전하게 맡기기
fornewid
1
980
React Native経験者が Flutterを30⽇間触って驚いたこと
3saito
0
180
S3 TablesのIcebergデータに、AIエージェントからアクセスしてみた / 20261016developersio2026joetsu-accessing-iceberg-in-s3tables-via-agent
kasacchiful
PRO
0
310
Будущее локальных LLM – Алексей Голобурдин, PythoNN
sobolevn
0
120
FactoryBotをやめればRSpecは速くなるのか?
yuta_onishi_97
0
1.7k
AI時代のIaC入門 〜なぜインフラをコードで管理したいのか?〜 / Introduction to IaC in the AI Era
akihisaikeda
6
1.5k
Featured
See All Featured
Cheating the UX When There Is Nothing More to Optimize - PixelPioneers
stephaniewalter
287
14k
Why You Should Never Use an ORM
jnunemaker
PRO
61
10k
svc-hook: hooking system calls on ARM64 by binary rewriting
retrage
2
670
Stewardship and Sustainability of Urban and Community Forests
pwiseman
0
590
Joys of Absence: A Defence of Solitary Play
codingconduct
1
570
Dealing with People You Can't Stand - Big Design 2015
cassininazir
367
27k
CSS Pre-Processors: Stylus, Less & Sass
bermonpainter
360
31k
How to build a perfect <img>
jonoalderson
1
6.2k
YesSQL, Process and Tooling at Scale
rocio
174
15k
Prompt Engineering for Job Search
mfonobong
0
580
DevOps and Value Stream Thinking: Enabling flow, efficiency and business value
helenjbeal
2
440
How to train your dragon (web standard)
notwaldorf
96
6.9k