OpenApiModelFactory.Parse Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| Parse(String, String, OpenApiReaderSettings) |
Reads the input string and parses it into an Open API document. |
| Parse<T>(String, OpenApiSpecVersion, OpenApiDocument, OpenApiDiagnostic, String, OpenApiReaderSettings) |
Reads the input string and parses it into an Open API document. |
Parse(String, String, OpenApiReaderSettings)
- Source:
- OpenApiModelFactory.cs
Reads the input string and parses it into an Open API document.
public static Microsoft.OpenApi.Reader.ReadResult Parse(string input, string? format = default, Microsoft.OpenApi.Reader.OpenApiReaderSettings? settings = default);static member Parse : string * string * Microsoft.OpenApi.Reader.OpenApiReaderSettings -> Microsoft.OpenApi.Reader.ReadResultPublic Shared Function Parse (input As String, Optional format As String = Nothing, Optional settings As OpenApiReaderSettings = Nothing) As ReadResultParameters
- input
- String
The input string.
- format
- String
The Open API format
- settings
- OpenApiReaderSettings
The OpenApi reader settings.
Returns
An OpenAPI document instance.
Applies to
Parse<T>(String, OpenApiSpecVersion, OpenApiDocument, OpenApiDiagnostic, String, OpenApiReaderSettings)
- Source:
- OpenApiModelFactory.cs
Reads the input string and parses it into an Open API document.
public static T? Parse<T>(string input, Microsoft.OpenApi.OpenApiSpecVersion version, Microsoft.OpenApi.OpenApiDocument openApiDocument, out Microsoft.OpenApi.Reader.OpenApiDiagnostic diagnostic, string? format = default, Microsoft.OpenApi.Reader.OpenApiReaderSettings? settings = default) where T : Microsoft.OpenApi.IOpenApiElement;static member Parse : string * Microsoft.OpenApi.OpenApiSpecVersion * Microsoft.OpenApi.OpenApiDocument * OpenApiDiagnostic * string * Microsoft.OpenApi.Reader.OpenApiReaderSettings -> 'T (requires 'T :> Microsoft.OpenApi.IOpenApiElement)Public Shared Function Parse(Of T As IOpenApiElement) (input As String, version As OpenApiSpecVersion, openApiDocument As OpenApiDocument, ByRef diagnostic As OpenApiDiagnostic, Optional format As String = Nothing, Optional settings As OpenApiReaderSettings = Nothing) As TType Parameters
- T
Parameters
- input
- String
The input string.
- version
- OpenApiSpecVersion
- openApiDocument
- OpenApiDocument
The OpenApiDocument object to which the fragment belongs, used to lookup references.
- diagnostic
- OpenApiDiagnostic
The diagnostic entity containing information from the reading process.
- format
- String
The Open API format
- settings
- OpenApiReaderSettings
The OpenApi reader settings.
Returns
An OpenAPI document instance.