Talk
Intermediate
Automating API Documentation with FastAPI
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.
Key Takeaways
None
References
Session Categories
FOSS
Speakers
Preksha Mahajan
Software Engineer Intern
Nielsen
Reviews
50
%
Approvability
1
Approvals
1
Rejections
1
Not Sure
This is cool
Reviewer #1
Approved
FastAPI has documentation with Swagger enabled by default - not sure how helpful or unique the overall topic is unless something else is also being covered as part of the same.
Reviewer #2
Rejected
Couldn't find any project on GitHub which can validate this proposal.
Reviewer #3
Not Sure