Class DefaultApiDocumentation

Represents default documentation information for an API.

Inheritance

object

DefaultApiDocumentation

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Innovt.AspNetCore.Model

Assembly: Innovt.AspNetCore.dll

Syntax

public class DefaultApiDocumentation

Constructors

DefaultApiDocumentation(string, string, string, string?, string?)

Initializes a new instance of the DefaultApiDocumentation class with the specified API details.

Declaration

public DefaultApiDocumentation(string apiTitle, string apiDescription, string apiVersion, string? contactName = null, string? contactEmail = null)

Parameters

Type	Name	Description
string	apiTitle	The title of the API.
string	apiDescription	The description of the API.
string	apiVersion	The version of the API.
string	contactName	The name of the contact person for the API (optional).
string	contactEmail	The email of the contact person for the API (optional).

Properties

ApiDescription

Gets or sets the description of the API.

Declaration

public string ApiDescription { get; set; }

Property Value

Type	Description
string

ApiTitle

Gets or sets the title of the API.

Declaration

public string ApiTitle { get; set; }

Property Value

Type	Description
string

ApiVersion

Gets or sets the version of the API.

Declaration

public string ApiVersion { get; set; }

Property Value

Type	Description
string

ContactEmail

Gets or sets the email of the contact person for the API (optional).

Declaration

public string? ContactEmail { get; set; }

Property Value

Type	Description
string

ContactName

Gets or sets the name of the contact person for the API (optional).

Declaration

public string? ContactName { get; set; }

Property Value

Type	Description
string

Extension Methods

Extensions.IsNull(object)

Extensions.ToStringOrDefault(object)

SimpleMapper.MapTo<T1>(object)