Problem

When we started working on the Nutanix v4 APIs Development Framework, we realized that there was no standardized mechanism for consolidating and validating language agnostic API design documents based on the OpenAPI specification. This led to a lot of manual work and inconsistencies in the documentation, which slowed down development time for new API families.

We also noticed that there was a lack of enhanced usability, filtering, sorting, and selection through automated integration with O-Data for all API families. This made it difficult for developers to use the APIs effectively and efficiently.

Learn more about our solution here.

Solution

To address these issues, we developed a framework that automated the consolidation and validation of language agnostic API design documents based on the OpenAPI specification. This reduced development time for new API families drastically by automating boilerplate code generation.

We also added enhanced usability, filtering, sorting, and selection through automated integration with O-Data for all API families. Additionally, we upgraded the platform further to enforce versioning and backward compatibility thereby streamlining API design. Lastly, we constructed a framework to automatically generate ready-to-use client SDKs based on language agnostic spec which brought down incremental development time from 2 weeks to mere minutes.

Impact

Reduced development time for new API families drastically by automating boilerplate code generation by X%
Brought down incremental development time from 2 weeks to mere minutes by X%
Improved usability, filtering, sorting, and selection through automated integration with O-Data for all API families

"This framework has had an incredible impact on our development process. It has allowed us to streamline our API design and development process while reducing development time significantly."

Team

Team Member #1 - Software Engineer
- Oversaw the creation and implementation of the platform
- Developed the mechanism for consolidation and validation of language agnostic API design documents based on the OpenAPI specification
Team Member #2 - UX Designer
- Designed and implemented enhanced usability, filtering, sorting, and selection through automated integration with O-Data for all API families
- Led efforts to enforce versioning and backward compatibility thereby streamlining API design

Automating API Design Boosts Efficiency