Linting API Workflows: Working with Arazzo Descriptions

Arazzo is a new specification by the ‪@OpenApi‬ Initiative (OAI) that supports the description of API workflows. How can you make sure that your Arazzo description is working the way you intend it to work? ‪@LornaMitchell‬ of ‪@redocly‬ shows how Arazzo linting is supported in their tooling.

One interesting takeaway is that Arazzo has been useful at ‪@redocly‬ as an internal tool. So even though the original intention of Arazzo was to support the interoperability of workflow descriptions, the internal value proposition was sufficient to implement Arazzo support.

With API workflows becoming increasingly important, looking at Arazzo becomes increasingly important for your organization. How can we describe sequences of API calls, how can we make this description machine-understandable, so that we can then test and validate assumptions about how APIs behave?

For 2025, we will probably see a significant increase in how organizations are describing and managing their API workflows. This may be for testing, for compliance, or for quality control. Bt in either case, making API workflows part of your API management and API description is probably a good goal to have for 2025.

If you're interested in regular news from the API space, subscribe to Getting APIs to Work here:    / erikwilde  

#api #apidesign #apidescription #openapi #apigovernance #arazzo #workflow #linting