After releasing the Arazzo Cheat Sheet in January, we wanted to go further and provide a step-by-step Arazzo guide. Shout-out to Phil Sturgeon for putting it together, after his great work on the OpenAPI complete guide!
To give you some context: Arazzo is a standard designed to describe API workflows, managed by the OpenAPI Initiative. While OpenAPI describes what an API can do (get train schedules from Paris to Marseille), Arazzo describes how to chain API calls to accomplish real business goals (book accommodation and transport for your next holiday).
We believe that most Arazzo files will not be written by humans but generated. Still, it’s key to understand how the underlying model works.
The first version of the specification was published in 2024. It has slowly built a reputation and enjoys growing support from various vendors throughout the API ecosystem.
👉 Discover the Arazzo complete guide
It’s a first release, and even though we carefully reviewed it, it may contain typos and small inconsistencies. Reach out to hello@bump.sh if you find anything misleading: your feedback are the best way for us to improve the guide.
You can also open issues to request changes or open pull requests in the GitHub repository: we would love to have you involved in its future iterations! The guide is CC BY-NC-SA 4.0 licensed.
Spread the word: this Arazzo knowledge base is intended to be shared with anyone working with API workflows. We are already heavy users and refer to it regularly when developing Bump.sh.
