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

API Documentation

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
humanlayerのブログから学ぶ、良いCLAUDE.mdの書き方
Avatar for Yuto tsukamoto1783
0
180
Apache Iceberg V3 and migration to V3
Avatar for Tomohiro Tanaka tomtanaka
0
150
AIエージェント、”どう作るか”で差は出るか？ / AI Agents: Does the "How" Make a Difference?
Avatar for r-kagaya rkaga
4
2k
AI前提で考えるiOSアプリのモダナイズ設計
Avatar for 野瀬田　裕樹 yuukiw00w
0
220
コマンドとリード間の連携に対する脅威分析フレームワーク
Avatar for Aja9tochin pandayumi
1
450
CSC307 Lecture 04
Avatar for Javier Gonzalez-Sanchez javiergs
PRO
0
660
AIと一緒にレガシーに向き合ってみた
Avatar for nyafunta9858 nyafunta9858
0
170
QAフローを最適化し、品質水準を満たしながらリリースまでの期間を最短化する #RSGT2026
Avatar for shibayu36 shibayu36
2
4.3k
フルサイクルエンジニアリングをAI Agentで全自動化したい 〜構想と現在地〜
Avatar for Kaito Minatoya kamina_zzz
0
400
責任感のあるCloudWatchアラームを設計しよう
Avatar for アキキー akihisaikeda
3
160
「ブロックテーマでは再現できない」は本当か？
Avatar for Takashi Kitajima inc2734
0
740
CSC307 Lecture 08
Avatar for Javier Gonzalez-Sanchez javiergs
PRO
0
670

Featured

See All Featured
Building Adaptive Systems
Avatar for Chris Keathley keathley
44
2.9k
Un-Boring Meetings
Avatar for Sebastian Deterding codingconduct
0
200
Become a Pro
Avatar for Speaker Deck speakerdeck
PRO
31
5.8k
Raft: Consensus for Rubyists
Avatar for Patrick Van Stee vanstee
141
7.3k
How To Speak Unicorn (iThemes Webinar)
Avatar for Michelle Schulp Hunt marktimemedia
1
380
Hiding What from Whom? A Critical Review of the History of Programming languages for Music
Avatar for Tomoya Matsuura tomoyanonymous
2
410
Designing for Timeless Needs
Avatar for Cassini Nazir cassininazir
0
130
Noah Learner - AI + Me: how we built a GSC Bulk Export data pipeline
Avatar for Tech SEO Connect techseoconnect
PRO
0
100
Jess Joyce - The Pitfalls of Following Frameworks
Avatar for Tech SEO Connect techseoconnect
PRO
1
63
sira's awesome portfolio website redesign presentation
Avatar for ElsiraPls elsirapls
0
140
How GitHub (no longer) Works
Avatar for Zach Holman holman
316
140k
Organizational Design Perspectives: An Ontology of Organizational Design Elements
Avatar for Dr. Kim W Petersen kimpetersen
PRO
1
110

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