Skip to content

README.md

Latest commit

 

History

History
117 lines (79 loc) · 3.37 KB

README.md

File metadata and controls

117 lines (79 loc) · 3.37 KB
Raw

NuGet Version GitHub Actions Workflow Status

OpenAPI Arazzo Library for dotnet

This project provides a .NET implementation of the OpenAPI Arazzo Specification, allowing you to manage workflows for REST APIs with OpenAPI documents (v3.0+), following the official OpenAPI Arazzo 1.0.0 specification.

The library enables developers to programmatically apply parse, build, serialize, validate arazzo documents.

This library was funded in part by the Interledger Foundation. See the related announcement: SDK Grant Funds Security Features, OpenAPI Specification, and Arazzo Workflow Support in Kiota.

Library

Installing the library

You can install this library via the package explorer or using the following command.

dotnet add <pathToCsProj> package BinkyLabs.OpenApi.Arazzo

Examples

Parsing an Arazzo document

The following example illustrates how you can load or parse an Arazzo document from JSON or YAML.

var (arazzoDocument) = await ArazzoDocument.LoadFromUrlAsync("https://source/arazzo.json");

CLI

Installing the CLI

You can install the Arazzo CLI as a dotnet tool.