Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
API Documentation
Search
Victor Antoniazzi
February 07, 2016
Programming
0
40
API Documentation
Victor Antoniazzi
February 07, 2016
Tweet
Share
More Decks by Victor Antoniazzi
See All by Victor Antoniazzi
Agile Methodologies
vgsantoniazzi
0
35
Extreme programming
vgsantoniazzi
0
40
Other Decks in Programming
See All in Programming
PHP8の機能を使って堅牢にコードを書く
fendo181
6
2.6k
もうすぐ新年度、Babylon.jsがお勧めな3個の理由
hideg
0
160
Building a Smaller App Binary
kateinoigakukun
2
200
Kotlinを用いたDSL的な設計手法と使用上の注意
kohii00
3
530
自動テスト実行結果の目的を整理する / Organizing objectives of automated test results
twada
PRO
10
2.1k
OpenTelemetry のサービスという概念について
azukiazusa1
1
390
document.write再考
brn
5
2.5k
Open Source Swift Workshop - Foundation and first party libraries
ikesyo
0
180
デザインシステムで Tailwind CSSとCSS in JSに分散投資をしたら良かった話
fsubal
14
3.2k
DDDはなぜ難しいのか / 良いコードの定義と設計能力の壁
pospome
24
7.3k
オブジェクト指向は必要なのか / Is object-oriented needed?
kishida
27
19k
生成 AI の中身を覗いてみよう〜基礎から医療現場での応用まで〜
soh9834
2
760
Featured
See All Featured
CoffeeScript is Beautiful & I Never Want to Write Plain JavaScript Again
sstephenson
153
14k
Design and Strategy: How to Deal with People Who Don’t "Get" Design
morganepeng
113
18k
For a Future-Friendly Web
brad_frost
170
8.9k
Exploring the Power of Turbo Streams & Action Cable | RailsConf2023
kevinliebholz
1
3.3k
Producing Creativity
orderedlist
PRO
335
39k
The MySQL Ecosystem @ GitHub 2015
samlambert
242
12k
Building a Modern Day E-commerce SEO Strategy
aleyda
15
6.3k
Java REST API Framework Comparison - PWX 2021
mraible
PRO
18
6.8k
VelocityConf: Rendering Performance Case Studies
addyosmani
319
23k
Building Flexible Design Systems
yeseniaperezcruz
317
37k
Gamification - CAS2011
davidbonilla
76
4.5k
Why Our Code Smells
bkeepers
PRO
330
56k
Transcript
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