Upgrade to Pro — share decks privately, control downloads, hide ads and more …

API Documentation

Sponsored · Ship Features Fearlessly Turn features on and off without deploys. Used by thousands of Ruby developers. →
Avatar for Victor Antoniazzi Victor Antoniazzi
February 07, 2016
Programming
0
42

API Documentation

Avatar for Victor Antoniazzi

Victor Antoniazzi

February 07, 2016
Tweet

More Decks by Victor Antoniazzi

See All by Victor Antoniazzi
Agile Methodologies
Avatar for Victor Antoniazzi vgsantoniazzi
0
38
Extreme programming
Avatar for Victor Antoniazzi vgsantoniazzi
0
41

Other Decks in Programming

See All in Programming
QAフローを最適化し、品質水準を満たしながらリリースまでの期間を最短化する #RSGT2026
Avatar for shibayu36 shibayu36
2
4.3k
React 19でつくる「気持ちいいUI」- 楽観的UIのすすめ
Avatar for Hiroshi Morishige himorishige
11
6k
Fragmented Architectures
Avatar for Denys Poltorak denyspoltorak
0
150
AI前提で考えるiOSアプリのモダナイズ設計
Avatar for 野瀬田　裕樹 yuukiw00w
0
220
MUSUBIXとは
Avatar for Hisaho nahisaho
0
130
Patterns of Patterns
Avatar for Denys Poltorak denyspoltorak
0
1.4k
Unicodeどうしてる？ PHPから見たUnicode対応と他言語での対応についてのお伺い
Avatar for てきめん tekimen youkidearitai
PRO
1
1.1k
コントリビューターによるDenoのすゝめ / Deno Recommendations by a Contributor
Avatar for petamoriken / 森建 petamoriken
0
200
Oxlintはいいぞ
Avatar for Yuji Yamaguchi yug1224
5
1.3k
フロントエンド開発の勘所 -複数事業を経験して見えた判断軸の違い-
Avatar for Yoichiro Kubo heimusu
7
2.8k
AI時代の認知負荷との向き合い方
Avatar for OptFit Corp. optfit
0
150
AIエージェント、”どう作るか”で差は出るか？ / AI Agents: Does the "How" Make a Difference?
Avatar for r-kagaya rkaga
4
2k

Featured

See All Featured
The Mindset for Success: Future Career Progression
Avatar for Greg Gifford greggifford
PRO
0
230
Java REST API Framework Comparison - PWX 2021
Avatar for Matt Raible mraible
34
9.1k
Un-Boring Meetings
Avatar for Sebastian Deterding codingconduct
0
200
Jamie Indigo - Trashchat’s Guide to Black Boxes: Technical SEO Tactics for LLMs
Avatar for Tech SEO Connect techseoconnect
PRO
0
55
SEO in 2025: How to Prepare for the Future of Search
Avatar for Michael King ipullrank
3
3.3k
Designing for humans not robots
Avatar for Tammie Lister tammielis
254
26k
16th Malabo Montpellier Forum Presentation
Avatar for AKADEMIYA2063 akademiya2063
PRO
0
47
How to Ace a Technical Interview
Avatar for Jacob Kaplan-Moss jacobian
281
24k
How to Get Subject Matter Experts Bought In and Actively Contributing to SEO & PR Initiatives.
Avatar for Liv Day livdayseo
0
63
Building Applications with DynamoDB
Avatar for Matt Wood mza
96
6.9k
End of SEO as We Know It (SMX Advanced Version)
Avatar for Michael King ipullrank
3
3.9k
Helping Users Find Their Own Way: Creating Modern Search Experiences
Avatar for Dan Newman danielanewman
31
3.1k

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