Upgrade to Pro — share decks privately, control downloads, hide ads and more …
Sign up for free

API Documentation

Avatar for Victor Antoniazzi Victor Antoniazzi
February 07, 2016
Programming
43
0

API Documentation

Avatar for Victor Antoniazzi

Victor Antoniazzi

February 07, 2016

More Decks by Victor Antoniazzi

See All by Victor Antoniazzi
Agile Methodologies
Avatar for Victor Antoniazzi vgsantoniazzi
0
39
Extreme programming
Avatar for Victor Antoniazzi vgsantoniazzi
0
42

Other Decks in Programming

See All in Programming
コードで差別化できない時代の ソフトウェアエンジニアリング / Software Engineering in an Era Where Code Doesn’t Differentiate
Avatar for Naoki Kishida kishida
2
180
Herb in Rails 8.2: Your ERB views, now HTML-aware @ Rails World 2026, Austin, Texas
Avatar for Marco Roth marcoroth
0
220
AmebaブログはKMPから卒業します
Avatar for 伊藤光次郎 kmars0605
0
190
Herb in Rails 8.2: Your ERB views, now HTML-aware @ Kaigi on Rails 2026, Tokyo, Japan
Avatar for Marco Roth marcoroth
2
230
contenteditable と日本語入力に向き合う
Avatar for taki colorful12
0
200
複雑なUIコンポーネントとの ⻑い付き合い⽅：波及するバグからテスト戦略を経て、安全な再設計へ
Avatar for masahiko.asai mixplace
0
420
[JA] Domain Modeling with Vanilla Rails: 「操作」から再考するRailsの設計論
Avatar for Yuichi Goto yasaichi
1
280
iOS 27でニュースアプリはどう変わる！？ 〜日経電子版の新機能対応と、開発事例から〜
Avatar for Kazuki Nakashima lynnswap
7
13k
AI時代のコードレビューは人に向けるな、仕組みに向けろ
Avatar for meijin texmeijin
5
3.7k
re:Inventに行く前に知っておきたい現地参加のノウハウ
Avatar for nokomoro3 nokomoro3
0
430
コードレビューのボトルネックを"する側"と"される側"の両面から解消する
Avatar for yub0n yub0n
2
1.6k
KiroのSpecで「五目並べ」を作ってみる
Avatar for Satoshi Kaneyasu satoshi256kbyte
1
380

Featured

See All Featured
Pawsitive SEO: Lessons from My Dog (and Many Mistakes) on Thriving as a Consultant in the Age of AI
Avatar for David Carrasco davidcarrasco
0
260
Build your cross-platform service in a week with App Engine
Avatar for Jose L jlugia
234
19k
Claude Code どこまでも/ Claude Code Everywhere
Avatar for nwiizo nwiizo
68
59k
Building Experiences: Design Systems, User Experience, and Full Site Editing
Avatar for Michelle Schulp Hunt marktimemedia
1
630
Helping Users Find Their Own Way: Creating Modern Search Experiences
Avatar for Dan Newman danielanewman
31
3.4k
職位にかかわらず全員がリーダーシップを発揮するチーム作り / Building a team where everyone can demonstrate leadership regardless of position
Avatar for MADOX madoxten
69
67k
Kristin Tynski - Automating Marketing Tasks With AI
Avatar for Tech SEO Connect techseoconnect
PRO
0
550
The untapped power of vector embeddings
Avatar for Frank van Dijk frankvandijk
2
1.9k
SERP Conf. Vienna - Web Accessibility: Optimizing for Inclusivity and SEO
Avatar for Sara Fernández Carmona sarafernandez
2
1.6k
How Software Deployment tools have changed in the past 20 years
Avatar for Geshan Manandhar geshan
2
35k
The Cost Of JavaScript in 2023
Avatar for Addy Osmani addyosmani
55
10k
The State of eCommerce SEO: How to Win in Today's Products SERPs - #SEOweek
Avatar for Aleyda Solis aleyda
2
12k

Transcript

  1. API documentation techniques, principles and practices

  2. Starting from beginning - Why should I document ?

  3. Starting from beginning - Why should I document - Small

    projects?

  4. Cost - document and write tests and refactor and develop

  5. Cost - Worth it?

  6. Concept - API blueprint (.apib)

  7. None

  8. Concept - json:api

  9. Tools

  10. None
  11. None

  12. Tools

  13. Tools - aglio --theme-style default --theme-style ./my-style.less -i input.apib -o

    output.html
  14. None

  15. Tools

  16. None
  17. None
  18. None
  19. None
  20. None

  21. Techniques - Documentation by environment

  22. Techniques - Aglio + git + script

  23. Techniques - docs.staging.4broders.com.br - docs.production.4broders.com.br