Share via

IOpenApiWriter Interface

Definition

Namespace:
Microsoft.OpenApi.Writers
Assembly:
Microsoft.OpenApi.dll
Package:
Microsoft.OpenApi v1.6.0

Interface for writing Open API documentation.

public interface IOpenApiWriter
type IOpenApiWriter = interface
Public Interface IOpenApiWriter
Derived

Methods

Flush()

Flush the writer.
WriteEndArray()

Write the end array.
WriteEndObject()

Write the end object.
WriteNull()

Write the null value.
WritePropertyName(String)

Write the property name.
WriteRaw(String)

Write the raw content value.
WriteStartArray()

Write the start array.
WriteStartObject()

Write the start object.
WriteValue(Boolean)

Write the boolean value.
WriteValue(Decimal)

Write the decimal value.
WriteValue(Int32)

Write the int value.
WriteValue(Object)

Write the object value.
WriteValue(String)

Write the string value.

Extension Methods

WriteAny<T>(IOpenApiWriter, T)

Write the IOpenApiAny value.
WriteExtensions(IOpenApiWriter, IDictionary<String,IOpenApiExtension>, OpenApiSpecVersion)

Write the specification extensions
WriteOptionalCollection(IOpenApiWriter, String, IEnumerable<String>, Action<IOpenApiWriter,String>)

Write the optional of collection string.
WriteOptionalCollection<T>(IOpenApiWriter, String, IEnumerable<T>, Action<IOpenApiWriter,T>)

Write the optional Open API object/element collection.
WriteOptionalMap(IOpenApiWriter, String, IDictionary<String,String>, Action<IOpenApiWriter,String>)

Write the optional Open API element map (string to string mapping).
WriteOptionalMap<T>(IOpenApiWriter, String, IDictionary<String,T>, Action<IOpenApiWriter,T>)

Write the optional Open API element map.
WriteOptionalMap<T>(IOpenApiWriter, String, IDictionary<String,T>, Action<IOpenApiWriter,String,T>)

Write the optional Open API element map.
WriteOptionalObject<T>(IOpenApiWriter, String, T, Action<IOpenApiWriter,T>)

Write the optional Open API object/element.
WriteProperty(IOpenApiWriter, String, Boolean, Boolean)

Write a boolean property.
WriteProperty(IOpenApiWriter, String, Nullable<Boolean>, Boolean)

Write a boolean property.
WriteProperty(IOpenApiWriter, String, String)

Write a string property.
WriteProperty<T>(IOpenApiWriter, String, T)

Write a string/number property.
WriteProperty<T>(IOpenApiWriter, String, Nullable<T>)

Write a primitive property.
WriteRequiredCollection<T>(IOpenApiWriter, String, IEnumerable<T>, Action<IOpenApiWriter,T>)

Write the required Open API object/element collection.
WriteRequiredMap(IOpenApiWriter, String, IDictionary<String,String>, Action<IOpenApiWriter,String>)

Write the required Open API element map (string to string mapping).
WriteRequiredMap<T>(IOpenApiWriter, String, IDictionary<String,T>, Action<IOpenApiWriter,T>)

Write the required Open API element map.
WriteRequiredObject<T>(IOpenApiWriter, String, T, Action<IOpenApiWriter,T>)

Write the required Open API object/element.
WriteRequiredProperty(IOpenApiWriter, String, String)

Write required string property.

Applies to