Making ENDs meet
Session Description
At Observe.AI, we had a lot of issues from finalizing API contract to API integration and keeping the data type in sync from DB to frontend.
We adopted some OSS to automate our tedious flows. We
started using API Specs for finalizing contract.
documented every API Spec in a JSON and exposed it through route (like Swagger)
started generating the API Client, Types and Interfaces out of it (in CI), completely removed human error chances.
started generating Test clients from the Specs, so also automated the test for APIs.
finally started using RTK Query Code Generation, which generates the client and has built in client-side caching
After all these changes, we immensely reduced human mistakes and data related errors and increased our development time from weeks to days.
Fun Fact: We integrated an API (from API contract finalization to prod release), we did in 2 hours, without our existing pipeline it could have easily taken 2 days.
Key Takeaways
Introducing proper API documentation as part of you SDLC, without hurting the project timeline.
Reducing human errors and data issues in production.
Reducing efforts of client-side developer, generating API client with caching in seconds from the API docs.
Generating API happy test cases, reducing some dev time.
Ultimately, reducing the development time of the project, by just using only open source.
Session Categories
Which track are you applying for?
Speakers
Abhishek Raj
Reviews
Good to see a proposal on API documentation challenges in the development cycle, highlighting adoption of open source tools. But unsure why the full names of tools are not mentioned anywhere in the proposal like how the emphasis was given to an organisation name in the beginning. Wouldn't hurt to add the tool names as they create discoverability for the talk, add credibility and allow the attendees to search for the tools before/after the talk. Including the open source tool names would enhance the value of the proposal significantly
I think this would work as a lightning talk better.
Thank you for submitting your proposal for IndiaFOSS 2025. Your submission was well-received and progressed to our final review stages.
Unfortunately, due to the high volume of excellent proposals this year, we were unable to select your talk for the final program. We appreciate the effort you put into your submission and encourage you to apply again for future events.