The Arazzo Specification: A New Way to Describe API Workflows - Budhaditya Bhattacharya, Tyk
Download as PPTX, PDF0 likes56 views
The document introduces Arazzo, a specification for describing API workflows in a human-readable format like YAML or JSON, enhancing the developer experience. Arazzo aims to streamline complex API descriptions, facilitate targeted code generation, and ensure regulatory compliance while improving the overall interaction with APIs. The document also outlines structure and components of the Arazzo specification, encouraging community engagement through GitHub and Slack.
The Arazzo Specification: A New Way to Describe API Workflows - Budhaditya Bhattacharya, Tyk
- 1. Arazzo: A new way to describe API workflows Platform Summit 2024
- 2. ❖ It describes an approach to document use-case oriented workflows in a programmatically readable format (YAML/JSON) ❖ A workflow is a series of API calls which when woven together accomplish a business outcome/ objective. ❖ The additional human readable nature improves the ability of API specifications to tell the story of the API(s) in a manner that can improve the consumer’s developer experience. What is the Arazzo Specification? v1.0.0
- 3. ❖ Deterministic recipes for the use of APIs ➢ Make sense of large unwieldy API description ➢ Bridge the gap where business flows span more than one API description ❖ Improved Developer Experience through living documentation ❖ Assertable business value ❖ Targeted code generation for APIs (driven by use cases) ❖ Improved regulatory checks and benchmarking (Open Banking, OpenID, OAuth) ❖ The AI potential for value oriented interaction with APIs (first time right, every time right) Dominant Use Cases
- 5. Lists source descriptions (e.g., OpenAPI description) that can be referenced by one or more workflows Metadata about the defined Arazzo Document Describes the workflows to be taken across one or more APIs to achieve an objective/outcome. A JSON Schema object representing the inputs used by this workflow The defined workflow steps, each representing a call to an API operation (or another workflow) A list of parameter objects, representing parameters to pass to an operation or workflow An array of failure action objects that specify what to do on step failure An array of success action objects that specify what to do upon step success A map between a friendly name and a dynamic output value for a step A map between a friendly name and a dynamic output value for a workflow
- 6. Reusable (referenceable) components and objects
- 7. ❖ GitHub: https://github.com/OAI/Arazzo-Specification ❖ Bi-weekly Call - Wednesdays at 09:00 AM PDT ❖ Discussions - Use the GitHub discussions to ask questions, provide opinions and engage with the group ❖ Issues - Feel free to submit a Github issue with any question or comment about the working group ❖ Slack - join the #arazzo channel at the OpenAPI slack workspace Resources - getting involved
- 8. Thank You!
Editor's Notes
- #1: Arazzo - tapestry in Italian Weaving different interactions with APIs together to achieve a meaningful outcome Why? When it comes to consuming APIs, more often than not, we need to do more than just a single API call to help us achieve our jobs to done