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
Victor Antoniazzi
February 07, 2016
Programming
43
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
39
Extreme programming
vgsantoniazzi
0
44
Other Decks in Programming
See All in Programming
SFCで実現する病院・医療システムの動的組み立て式UI
koukimiura
1
180
Web3Dライブラリを作ってVue Custom Rendererの仕組みを理解しよう / lets learn vue custom renderer by making 3d library
drumath2237
1
130
Rails初心者がパスキーを実装してみて大変だったこと
ktombow
0
170
Engineering Biometric UX Across Android Versions | DroidKnights 2026
ryunen344
1
200
Zero-Tap Sign-In対応、結局何をすればいいの?
mitohato14
0
2.1k
3回つくってわかった、 定期実行ジョブ基盤の本質情報
takai
4
3.8k
私なりのハーネスエンジニアリング ~独自の言語処理系の開発を通して~
seosoft
0
200
Distance field of Julia set
kinakomoti321
0
320
AIがコードを書いてくれる時代、我々は何を確かめるのか
yosuke_furukawa
PRO
13
5.9k
Performance Optimization With LLMs
xleitix
0
250
あなたの await、OS まで届いてる? strace で覗く JavaScript の非同期
hasutosasaki
1
2.3k
조합이폭발하는디자인시스템이걸눈으로도테스트하라고요
giljongyu
0
750
Featured
See All Featured
I Don’t Have Time: Getting Over the Fear to Launch Your Podcast
jcasabona
35
2.9k
Agile that works and the tools we love
rasmusluckow
331
22k
[RailsConf 2023 Opening Keynote] The Magic of Rails
eileencodes
31
10k
Pawsitive SEO: Lessons from My Dog (and Many Mistakes) on Thriving as a Consultant in the Age of AI
davidcarrasco
1
300
Scaling GitHub
holman
464
140k
GraphQLとの向き合い方2022年版
quramy
50
15k
The Psychology of Web Performance [Beyond Tellerrand 2023]
tammyeverts
49
3.6k
Being A Developer After 40
akosma
PRO
92
590k
Leveraging Curiosity to Care for An Aging Population
cassininazir
1
560
Lessons Learnt from Crawling 1000+ Websites
charlesmeaden
PRO
1
1.7k
Ecommerce SEO: The Keys for Success Now & Beyond - #SERPConf2024
aleyda
1
2.3k
Keith and Marios Guide to Fast Websites
keithpitt
413
23k