Skip to Main Content
Talk Intermediate

Automating API Documentation with FastAPI

Proposal status is Rejected
Session Description

As we know, Bad docs == Frustrated developers while Good docs == Happy developers.


API documentation is crucial for smooth integration, yet manual documentation is often outdated, inconsistent and hard to maintain.


FastAPI, a modern and Open Source asynchronous web framework, automates API documentation using OpenAPI and JSON Schema, ensuring your docs are always up-to-date, with zero extra effort.


In this talk, I'll cover:

  • Impact of API documentation
  • Issues with manual documentation
  • FastAPI + OpenAPI
  • Live Demo, where participants will get a chance to explore Swagger UI & ReDoc
  • Customizing OpenAPI
  • QnA

By the end, I'll be able to show how FastAPI, backed by open source principles, makes API documentation effortless, improving developer experience and API adoption while embracing the power of FOSS.

Session Categories

FOSS

Speakers

Preksha Mahajan
Preksha Mahajan Software Engineer Intern | Nielsen

Preksha Mahajan is working as a Software Engineer Intern at Nielsen. She is pursuing a Bachelor of Engineering degree in Computer Science Engineering, with a keen interest in Open Source world and Web (Backend) Development.


She serves as the Mentor and previously, Community Lead at Open Source Chandigarh, a tech community powered by Chitkara University and supported by tech giants like GitHub, Docker Inc., Collabnix, Webiny, Apache Local Community Indore, and OpsTree Solutions. Through this role, Preksha contributes to fostering a collaborative environment for tech enthusiasts and redefining the future of tech at Chitkara University and beyond.


She has been working on various projects using Python, C/C++, HTML, CSS, Bootstrap, JavaScript, SQL, MongoDB and has gained proficiency in Python libraries like Pandas, Matplotlib, NumPy, Scikit-learn and frameworks like: FastAPI.


Preksha is passionate about staying updated with the latest technological advancements and learning new skills and tools. She led a revolutionary initiative called #100daysofcodeatChitkara on LinkedIn and Twitter, promoting coding culture and craft among students of Chitkara University.


Additionally, she is passionate about community building, team management, content creation, public speaking and has delivered multiple talks around Open Source, Programming, Web Development and Community Building.


PS: She is also a National level Chess player and represented Punjab in SGFI, 2019.