| title | description | author | ms.author | ms.topic |
|---|---|---|---|---|
Upgrade guide to OpenAPI.NET 2.1 |
Learn how to upgrade your OpenAPI.NET version from 1.6 to 2.0 |
rachit.malik |
malikrachit |
conceptual |
We are excited to announce the preview of a new version of the OpenAPI.NET library!
OpenAPI.NET v2 is a major update to the OpenAPI.NET library. This release includes a number of performance improvements, API enhancements, and support for OpenAPI v3.1.
Since the release of the first version of the OpenAPI.NET library in 2018, there has not been a major version update to the library. With the addition of support for OpenAPI v3.1 it was necessary to make some breaking changes. With this opportunity, we have taken the time to make some other improvements to the library, based on the experience we have gained supporting a large community of users for the last six years .
One of the key features of OpenAPI.NET is its performance. This version makes it possible to parse JSON based OpenAPI descriptions even faster. OpenAPI.NET v1 relied on the excellent YamlSharp library for parsing both JSON and YAML files. With OpenAPI.NET v2 we are relying on System.Text.Json for parsing JSON files. For YAML files, we continue to use YamlSharp to parse YAML but then convert to JsonNodes for processing. This allows us to take advantage of the performance improvements in System.Text.Json while still supporting YAML files.
In v1, instances of $ref were resolved in a second pass of the document to ensure the target of the reference has been parsed before attempting to resolve it. In v2, reference targets are lazily resolved when reference objects are accessed. This improves load time performance for documents that make heavy use of references.
[How does this change the behaviour of external references?]
In OpenAPI v1, it was necessary to include the Microsoft.OpenApi.Readers library to be able to read OpenAPI descriptions in either YAML or JSON. In OpenAPI.NET v2, the core Microsoft.OpenAPI library can both read and write JSON. It is only necessary to use the newly renamed Microsoft.OpenApi.YamlReader library if you need YAML support. This allows teams who are only working in JSON to avoid the additional dependency and therefore eliminate all non-.NET library references.
Once the dependency is added, the reader needs to be added to the reader settings as demonstrated below
var settings = new OpenApiReaderSettings();
settings.AddYamlReader();
var result = OpenApiDocument.LoadAsync(openApiString, settings: settings); The v1 library attempted to mimic the pattern of XmlTextReader and JsonTextReader for the purpose of loading OpenAPI documents from strings, streams and text readers.
var reader = new OpenApiStringReader();
var openApiDoc = reader.Read(stringOpenApiDoc, out var diagnostic);The same pattern can be used for OpenApiStreamReader and OpenApiTextReader. When we introduced the ReadAsync methods we eliminated the use of the out parameter.
var reader = new OpenApiStreamReader();
var (document, diagnostics) = await reader.ReadAsync(streamOpenApiDoc);A ReadResult object acts as a tuple of OpenApiDocument and OpenApiDiagnostic.
The challenge with this approach is that the reader classes are not very discoverable and the behaviour is not actually consistent with the *TextReader pattern that allows incrementally reading the document. This library does not support incrementally reading the OpenAPI Document. It only reads a complete document and returns an OpenApiDocument instance.
In the v2 library we are moving to the pattern used by classes like XDocument where a set of static Load and Parse methods are used as factory methods.
public class OpenApiDocument {
public static async Task<ReadResult> LoadAsync(string url, OpenApiReaderSettings settings = null) {}
public static async Task<ReadResult> LoadAsync(Stream stream, string? format = null, OpenApiReaderSettings? settings = null) {}
public static ReadResult Load(MemoryStream stream, string? format = null, OpenApiReaderSettings? settings = null) {}
public static ReadResult Parse(string input, string? format = null, OpenApiReaderSettings? settings = null) {}
}This API design allows a developer to use IDE autocomplete to present all the loading options by simply knowing the name of the OpenApiDocument class. Each of these methods are layered on top of the more primitive methods to ensure consistent behaviour.
As the YAML format is only supported when including the Microsoft.OpenApi.YamlReader library it was decided not to use an enum for the format parameter. We are considering implementing a more strongly typed solution similar to the way that HttpMethod is implemented so that we have a strongly typed experience that is also extensible.
When the loading methods are used without a format parameter, we will attempt to parse the document using the default JSON reader. If that fails and the YAML reader is registered, then we will attempt to read as YAML. The goal is always to provide the fastest path with JSON but still maintain the convenience of not having to care whether a URL points to YAML or JSON if you need that flexibility.
In the OpenAPI specification, there are a few properties that are defined as type any. This includes:
- the example property in the parameter, media type objects
- the value property in the example object
- the values in the link object's parameters dictionary and
requestBodyproperty - all
x-extension properties
In the v1 library, there are a set of classes that are derived from the OpenApiAny base class which is an abstract model which reflects the JSON data model plus some additional primitive types such as decimal, float, datetime etc.
In v2 we are removing this abstraction and relying on the JsonNode model to represent these inner types. In v1 we were not able to reliably identify the additional primitive types and it caused a significant amount of false negatives in error reporting as well as incorrectly parsed data values.
Due to JsonNode implicit operators, this makes initialization sometimes easier, instead of:
new OpenApiParameter
{
In = null,
Name = "username",
Description = "username to fetch",
Example = new OpenApiFloat(5),
};the assignment becomes simply,
Example = 0.5f,For a more complex example, where the developer wants to create an extension that is an object they would do this in v1:
var openApiObject = new OpenApiObject
{
{"stringProp", new OpenApiString("stringValue1")},
{"objProp", new OpenApiObject()},
{
"arrayProp",
new OpenApiArray
{
new OpenApiBoolean(false)
}
}
};
var parameter = new OpenApiParameter();
parameter.Extensions.Add("x-foo", new OpenApiAny(openApiObject));In v2, the equivalent code would be,
var openApiObject = new JsonObject
{
{"stringProp", "stringValue1"},
{"objProp", new JsonObject()},
{
"arrayProp",
new JsonArray
{
false
}
}
};
var parameter = new OpenApiParameter();
parameter.Extensions.Add("x-foo", new OpenApiAny(openApiObject));The OpenAPI 3.1 specification changes significantly how it leverages JSON Schema. In 3.0 and earlier, OpenAPI used a "subset, superset" of JSON Schema draft-4. This caused many problems for developers trying to use JSON Schema validation libraries with the JSON Schema in their OpenAPI descriptions. In OpenAPI 3.1, the 2020-12 draft version of JSON Schema was adopted and a new JSON Schema vocabulary was adopted to support OpenAPI specific keywords. All attempts to constrain what JSON Schema keywords could be used in OpenAPI were removed.
/// $schema, a JSON Schema dialect identifier. Value must be a URI
public string Schema { get; set; }
/// $id - Identifies a schema resource with its canonical URI.
public string Id { get; set; }
/// $comment - reserves a location for comments from schema authors to readers or maintainers of the schema.
public string Comment { get; set; }
/// $vocabulary- used in meta-schemas to identify the vocabularies available for use in schemas described by that meta-schema.
public IDictionary<string, bool> Vocabulary { get; set; }
/// $dynamicRef - an applicator that allows for deferring the full resolution until runtime, at which point it is resolved each time it is encountered while evaluating an instance
public string DynamicRef { get; set; }
/// $dynamicAnchor - used to create plain name fragments that are not tied to any particular structural location for referencing purposes, which are taken into consideration for dynamic referencing.
public string DynamicAnchor { get; set; }
/// $defs - reserves a location for schema authors to inline re-usable JSON Schemas into a more general schema.
public IDictionary<string, OpenApiSchema> Definitions { get; set; }
public IDictionary<string, OpenApiSchema> PatternProperties { get; set; } = new Dictionary<string, OpenApiSchema>();
public bool UnevaluatedProperties { get; set;} public string? ExclusiveMaximum { get; set; } // type changed to reflect the new version of JSON schema
public string? ExclusiveMinimum { get; set; } // type changed to reflect the new version of JSON schema
public JsonSchemaType? Type { get; set; } // Was string, now flagged enum
public string? Maximum { get; set; } // type changed to overcome double vs decimal issues
public string? Minimum { get; set; } // type changed to overcome double vs decimal issues
public JsonNode Default { get; set; } // Type matching no longer enforced. Was IOpenApiAny
public bool ReadOnly { get; set; } // No longer has defined semantics in OpenAPI 3.1
public bool WriteOnly { get; set; } // No longer has defined semantics in OpenAPI 3.1
public JsonNode Example { get; set; } // No longer IOpenApiAny
public IList<JsonNode> Examples { get; set; }
public IList<JsonNode> Enum { get; set; }
public OpenApiExternalDocs ExternalDocs { get; set; } // OpenApi Vocab
public bool Deprecated { get; set; } // OpenApi Vocab
public OpenApiXml Xml { get; set; } // OpenApi Vocab
public IDictionary<string, object> Metadata { get; set; } // Custom property bag to be used by the application, used to be named annotationsOther than the addition of SerializeAsV31, the methods have not changed.
public class OpenApiSchema : IOpenApiAnnotatable, IOpenApiExtensible, IOpenApiReferenceable, IOpenApiSerializable
{
public OpenApiSchema() { }
public OpenApiSchema(OpenApiSchema schema) { }
public void SerializeAsV31(IOpenApiWriter writer) { }
public void SerializeAsV3(IOpenApiWriter writer) { }
public void SerializeAsV2(IOpenApiWriter writer) { }
}There are a number of new features in OpenAPI v3.1 that are now supported in OpenAPI.NET.
public class OpenApiDocument : IOpenApiSerializable, IOpenApiExtensible, IOpenApiAnnotatable {
/// <summary>
/// The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement.
/// A map of requests initiated other than by an API call, for example by an out of band registration.
/// The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses
/// </summary>
public IDictionary<string, OpenApiPathItem>? Webhooks { get; set; } = new Dictionary<string, OpenApiPathItem>();
} /// <summary>
/// Open API Info Object, it provides the metadata about the Open API.
/// </summary>
public class OpenApiInfo : IOpenApiSerializable, IOpenApiExtensible
{
/// <summary>
/// A short summary of the API.
/// </summary>
public string Summary { get; set; }
} /// <summary>
/// License Object.
/// </summary>
public class OpenApiLicense : IOpenApiSerializable, IOpenApiExtensible
{
/// <summary>
/// An SPDX license expression for the API. The identifier field is mutually exclusive of the Url property.
/// </summary>
public string Identifier { get; set; }
} /// <summary>
/// Components Object.
/// </summary>
public class OpenApiComponents : IOpenApiSerializable, IOpenApiExtensible
{
/// <summary>
/// An object to hold reusable <see cref="OpenApiPathItem"/> Object.
/// </summary>
public IDictionary<string, OpenApiPathItem>? PathItems { get; set; } = new Dictionary<string, OpenApiPathItem>();
}Through the use of proxy objects in order to represent references, it is now possible to set the Summary and Description property on an object that is a reference. This was previously not possible.
var parameter = new OpenApiParameterReference("id", hostdocument)
{
Description = "Customer Id"
};HTTP methods are now represented as objects instead of enums. This change enhances flexibility but requires updates to how HTTP methods are handled in your code. Example:
// Before (1.6)
OpenApiOperation operation = new OpenApiOperation
{
HttpMethod = OperationType.Get
};
// After (2.0)
OpenApiOperation operation = new OpenApiOperation
{
HttpMethod = new HttpMethod("GET") // or HttpMethod.Get
};Version 2.0 preview 13 introduces support for null reference types, which improves type safety and reduces the likelihood of null reference exceptions.
Example:
// Before (1.6)
OpenApiDocument document = new OpenApiDocument
{
Components = new OpenApiComponents()
};
// After (2.0)
OpenApiDocument document = new OpenApiDocument
{
Components = new OpenApiComponents()
{
Schemas = new Dictionary<string, IOpenApiSchema?>()
}
};References can now be used as components, allowing for more modular and reusable OpenAPI documents.
Example:
// Before (1.6)
OpenApiSchema schema = new OpenApiSchema
{
Reference = new OpenApiReference
{
Type = ReferenceType.Schema,
Id = "MySchema"
}
};
// After (2.0)
OpenApiComponents components = new OpenApiComponents
{
Schemas = new Dictionary<string, IOpenApiSchema>
{
["MySchema"] = new OpenApiSchema
{
Reference = new OpenApiSchemaReference("MySchema")
}
}
};The SerializeAs() method simplifies serialization scenarios, making it easier to convert OpenAPI documents to different formats.
Example:
OpenApiDocument document = new OpenApiDocument();
string json = document.SerializeAs(OpenApiSpecVersion.OpenApi3_0, OpenApiFormat.Json);Fixed a bug where references would not serialize summary or descriptions in OpenAPI 3.1. Example:
OpenApiSchemaReference schemaRef = new OpenApiSchemaReference("MySchema")
{
Summary = "This is a summary",
Description = "This is a description"
};If you have any feedback please file a GitHub issue here The team is looking forward to hear your experience trying the new version and we hope you have fun busting out your OpenAPI 3.1 descriptions.