Sisk

Class

OpenApiExporter

Namespace
Sisk.Documenting.Exporters
Assembly
Sisk.Documenting.dll

Exports API documentation to OpenAPI 3.0 format.

C#
public sealed class OpenApiExporter : IApiDocumentationExporter

Inheritance #

object ← OpenApiExporter

Implements #

IApiDocumentationExporter

Inherited Members #

object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Constructors #

NameDescription
OpenApiExporter()Initializes a new instance of the OpenApiExporter class.

Properties #

NameDescription
ContactGets or sets the contact information for the API.
LicenseGets or sets the license information for the API.
OpenApiVersionGets or sets the OpenAPI version. Default is “3.0.0”.
ServerUrlsGets or sets the server URLs for the API.
TermsOfServiceGets or sets the terms of service URL for the API.

Methods #

NameDescription
ExportDocumentationContent(ApiDocumentation)Exports the specified API documentation content to OpenAPI format.

Type to search the documentation and the API reference.