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
Next.js: The final boss of Web Performance
Avatar for Estela Franco guaca
0
260
iOS 27でニュースアプリはどう変わる！？ 〜日経電子版の新機能対応と、開発事例から〜
Avatar for Kazuki Nakashima lynnswap
7
13k
全ての永続トークンを、生まれる前に消し去りたい！
Avatar for sylph01 sylph01
2
930
Event is what happens
Avatar for MOROHASHI Kyosuke moro
2
810
AIで開発が速くなった先で、開発チームは何を目指すか
Avatar for Yuki Shiho shihochan
0
1.4k
R8 の設定見直しでアプリサイズ削減
Avatar for ANDPAD inc andpad
0
220
Vue Fes Japan の “作る側”に関わってみて
Avatar for Naoki Haba naokihaba
0
160
カツオ、ご期待ください
Avatar for saku_totomi suneo3476
0
190
[JA] Domain Modeling with Vanilla Rails: 「操作」から再考するRailsの設計論
Avatar for Yuichi Goto yasaichi
1
280
Jetpack Compose Mechanisms
Avatar for Jaewoong skydoves
3
820
When benchmarks go bad - what I learned from measuring performance wrong
Avatar for Holly Cummins hollycummins
0
220
見えないものを探る要求要件定義に必要な基本的思考 / invisible-requirement-thinking
Avatar for MinoDriven minodriven
15
8.5k

Featured

See All Featured
職位にかかわらず全員がリーダーシップを発揮するチーム作り / Building a team where everyone can demonstrate leadership regardless of position
Avatar for MADOX madoxten
69
67k
What’s in a name? Adding method to the madness
Avatar for The Alliance productmarketing
PRO
24
4.2k
Building AI with AI
Avatar for Ines Montani inesmontani
PRO
1
1.3k
Game over? The fight for quality and originality in the time of robots
Avatar for Wayne Barker wayneb77
1
300
How Fast Is Fast Enough? [PerfNow 2025]
Avatar for Tammy Everts tammyeverts
3
940
sira's awesome portfolio website redesign presentation
Avatar for ElsiraPls elsirapls
0
460
Large-scale JavaScript Application Architecture
Avatar for Addy Osmani addyosmani
516
110k
Become a Pro
Avatar for Speaker Deck speakerdeck
PRO
31
6.3k
Chrome DevTools: State of the Union 2024 - Debugging React & Beyond
Avatar for Addy Osmani addyosmani
10
1.4k
Music & Morning Musume
Avatar for Bryan Veloso bryan
48
7.4k
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
Design of three-dimensional binary manipulators for pick-and-place task avoiding obstacles (IECON2024)
Avatar for konakalab konakalab
0
620

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