apidays LIVE Paris 2021 - Automating API Documentation by Ajinkya Marudwar, GS Lab

•

0 gostou•154 visualizações

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

Tecnologia

Automating API
Documentation
Ajinkya Marudwar
Lead Technical Writer at Privacera

Agenda
• API Documentation Process
• Automated API Documentation Setup
• Why Automated
• How its done
• Output Comparison
• Q & A

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

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

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

Automated API Documentation Setup
System Perquisite
• Hardware
⚬ RAM - 2 GB
⚬ ROM- 100 GB
• Software
⚬ Linux / Windows / MAC
⚬ Python
⚬ Sphinx
⚬ Latex
⚬ Text Editor Part I

Automated API Documentation Setup
Source Folder
• RST Files
• Schema Files
• Artifact Files
• CSS
• Conf.py
• Index
• Python scripts
Part II

a. python description.py schemas -a
b. python json_to_rst.py schemas/
c. sphinx-build source api
Python Script

Automated Sphinx Output - Endpoint page example

Do you have
any questions?
Send it to us! We hope you learned
something new.

Mais conteúdo relacionado

Mais procurados

apidays LIVE Paris 2021 - OpenAPI Generator - The Babel Fish of the API World...

apidays

apidays LIVE Paris 2021 - Spatially enabling Web APIs through OGC Standards ...

apidays

INTERFACE, by apidays - APIs from consumption to contribution by Kristof Van...

apidays

apidays LIVE Paris 2021 - Who writes the Docs? by Laura Vass, Pronovix

apidays

INTERFACE, by apidays - The 8 Key Components of a Modern API Stack by Iddo G...

apidays

apidays LIVE London 2021 - API design is where culture and tech meet each oth...

apidays

apidays LIVE Paris 2021 - Building an analytics API by David Wobrock, Botify

apidays

apidays LIVE Paris 2021 - 20 Minutes to Build a Serverless COVID-19 GraphQL A...

apidays

apidays LIVE Paris 2021 - Beyond API Governance: Run your API org like a lean...

apidays

Beyond the basic Swagger UI: Adyen API Explorer

Aleksei Akimov

INTERFACE, by apidays - Aligning teams and strategies behind API investment ...

apidays

INTERFACE, by apidays - API Design is where culture and tech meet each other...

apidays

apidays LIVE Australia 2021 - Designing APIs: Just Enough is Perfect! by Dami...

apidays

apidays LIVE Australia 2021 - From apps to APIs: how no-code is transforming ...

apidays

APIs are the fundamental tenets of the Internet. They enable integrations between different services, and they power the servers that bring our applications to life. API integrations lay at the core of our API-driven world, and delivering successful API integrations is fundamental to sustain it. However, more often than not, API integrations tend to fail due to ineffective development workflows. In this presentation, I want to present various API development workflows that have helped me and my clients deliver successful API integrations. I’ll show how documentation-driven development, using mock servers, robust API testing frameworks, and API visibility tools can help to significantly reduce the chances of API integration failure and to keep errors under control.

Pure APIs: Development workflows for successful API integrations

José Haro Peralta

Guide to an API-first Strategy

Kellton Tech Solutions Ltd

Presented by: Tom Wilson, hyper63 Presented at the All Things Open Virtual Meetup Abstract: APIs (Application Program Interfaces) is how programs can talk with other programs and is a design consideration for many products. Let’s discuss: Why you should build an application with an API? What are the top 5 requirements of designing an API with examples? Some open-source javascript frameworks that can help you design and build your API. In order to get the most out of this talk, you should have a good understanding of http REST protocol and general application development. Familiarity with javascript and technologies like NodeJS and Express would be a plus. In this talk, you should come away with a good understanding of why you should consider building an API in your application, key good practices every API should include, and how you could implement an API using Javascript.

A Starters Guide to Building APIs with Javascript

All Things Open

API Design Collaboration

Uchit Vyas ☁

APIDays - API Design Workshop

Restlet

apidays LIVE Paris 2021 - Detecting and Protecting PII by Rob Dickinson, Resu...

apidays

Mais procurados (20)