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 Documentation
Search
Sponsored
·
Ship Features Fearlessly
Turn features on and off without deploys. Used by thousands of Ruby developers.
→
Victor Antoniazzi
February 07, 2016
Programming
45
0
Share
Embed
Copy iframe code
Copy JS code
Copy link
Start on current slide
API Documentation
Victor Antoniazzi
February 07, 2016
Transcript
23 slides
API documentation techniques, principles and practices
Starting from beginning - Why should I document ?
Starting from beginning - Why should I document - Small
projects?
Cost - document and write tests and refactor and develop
Cost - Worth it?
Concept - API blueprint (.apib)
None
Concept - json:api
Tools
None
None
Tools
Tools - aglio --theme-style default --theme-style ./my-style.less -i input.apib -o
output.html
None
Tools
None
None
None
None
None
Techniques - Documentation by environment
Techniques - Aglio + git + script
Techniques - docs.staging.4broders.com.br - docs.production.4broders.com.br
More Decks by Victor Antoniazzi
See All by Victor Antoniazzi
Agile Methodologies
vgsantoniazzi
0
40
Extreme programming
vgsantoniazzi
0
45
Other Decks in Programming
See All in Programming
Kawaiicon: Kubernetes, it's no longer cool, but let's secure it anyway!
barnbarn
0
150
将来の標準フォーマッター?ktfmtを深堀る
t45k
0
250
疎結合とは何か?ソフトウェア設計における結合バランスについて考える #phpcon_niigata
kajitack
2
420
AI時代のFlutter品質設計 — アプリ品質を守るQuality Layers
omatty198
0
390
AI時代のシニアエンジニアとは
yosuke_furukawa
PRO
15
12k
高橋メソッドでCVE解説シリーズ 〜CVE-2026-112816〜
hakkadaikon
0
270
Engineering Biometric UX Across Android Versions | DroidKnights 2026
ryunen344
1
220
例外からRich Errorsまで Kotlinエラーハンドリングの進化を読み解く
shiita0903
0
240
エージェントの管理もエージェントに – herdr-core と自作バックログで作る司令塔 –
nearme_tech
PRO
1
120
あなたはMCPの機能を、まだ知らない。
4geru
1
740
Scalaの型でマルチテナントの認可を守る
nextbeatdev
0
180
SODA - FACT BOOK(EN)
sodainc
1
280
Featured
See All Featured
Producing Creativity
orderedlist
PRO
348
41k
Digital Projects Gone Horribly Wrong (And the UX Pros Who Still Save the Day) - Dean Schuster
uxyall
2
4k
Tell your own story through comics
letsgokoyo
1
1.1k
Distributed Sagas: A Protocol for Coordinating Microservices
caitiem20
333
23k
Why You Should Never Use an ORM
jnunemaker
PRO
61
10k
Build your cross-platform service in a week with App Engine
jlugia
234
19k
Ethics towards AI in product and experience design
skipperchong
2
470
Kristin Tynski - Automating Marketing Tasks With AI
techseoconnect
PRO
0
600
Design in an AI World
tapps
1
400
From π to Pie charts
rasagy
1
460
Test your architecture with Archunit
thirion
2
2.5k
Collaborative Software Design: How to facilitate domain modelling decisions
baasie
1
390