apidays LIVE Paris 2021 - APIs and the Future of Software
December 7, 8 & 9, 2021
Automating API Documentation
Ajinkya Marudwar, Sr. Technical Writer at GS Lab
2. Agenda
• API Documentation Process
• Automated API Documentation Setup
• Why Automated
• How its done
• Output Comparison
• Q & A
3. Manual API
Documentation
• Pros
⚬ Develop using any authoring tool
⚬ Easy to start
⚬ Good for small products with minimum
updates
• Cons
⚬ API knowledge is must
⚬ Testing and verification is required
⚬ Prone to human error
⚬ Maintenance is difficult
Automated API
Documentation
• Pros
⚬ Easy to maintain
⚬ Accurate and consistent output
⚬ Less prone to error
⚬ Maintenance is easy
⚬ Beginner API knowledge
• Cons
⚬ System setup is required
⚬ Need to understand code
4. Why Automated API Docs?
• Multiple releases (50 - 150 features)
• 29 Modules
• 13000+ endpoints
• Generation only takes 120 mins
• No more dependency on writer
• Complete guide is updated based on release build
• Generated in HTML and PDF format
• Efficient search
5. New York
JULY
Australia
SEPTEMBER
Singapore
APRIL
Helsinki & North
MARCH
Paris
DECEMBER
London
OCTOBER
Jakarta
FEBRUARY
Hong Kong
AUGUST
JUNE
India
MAY
Check out our API Conferences here
50+ events since 2012, 14 countries, 2,000+ speakers, 50,000+ attendees,
300k+ online community
Want to talk at one of our conferences?
Apply to speak here
6. Automated API Documentation Setup
System Perquisite
• Hardware
⚬ RAM - 2 GB
⚬ ROM- 100 GB
• Software
⚬ Linux / Windows / MAC
⚬ Python
⚬ Sphinx
⚬ Latex
⚬ Text Editor Part I
7. Automated API Documentation Setup
Source Folder
• RST Files
• Schema Files
• Artifact Files
• CSS
• Conf.py
• Index
• Python scripts
Part II
16. New York
JULY
Australia
SEPTEMBER
Singapore
APRIL
Helsinki & North
MARCH
Paris
DECEMBER
London
OCTOBER
Jakarta
FEBRUARY
Hong Kong
AUGUST
JUNE
India
MAY
Check out our API Conferences here
50+ events since 2012, 14 countries, 2,000+ speakers, 50,000+ attendees,
300k+ online community
Want to talk at one of our conferences?
Apply to speak here