C# Class Swagger.ObjectModel.Builders.ApiKeySecuritySchemeBuilder

The api key security scheme builder.
Inheritance: SecuritySchemeBuilder
Datei anzeigen Open project: khellang/Nancy.Swagger

Public Methods

Method Description
Build ( ) : SecurityScheme

The build.
Description ( string description ) : ApiKeySecuritySchemeBuilder

A short description for security scheme.
IsInHeader ( ) : ApiKeySecuritySchemeBuilder

Declare that the API key is located in a header
IsInQuery ( ) : ApiKeySecuritySchemeBuilder

Declare that the API key is located in the query
Name ( string name ) : ApiKeySecuritySchemeBuilder

The name.

Private Methods

Method Description
In ( ApiKeyLocations securityIn ) : ApiKeySecuritySchemeBuilder

The in.

Method Details

Build() public method

The build.
///
public Build ( ) : SecurityScheme
return SecurityScheme

Description() public method

A short description for security scheme.
public Description ( string description ) : ApiKeySecuritySchemeBuilder
description string /// The description. ///
return ApiKeySecuritySchemeBuilder

IsInHeader() public method

Declare that the API key is located in a header
public IsInHeader ( ) : ApiKeySecuritySchemeBuilder
return ApiKeySecuritySchemeBuilder

IsInQuery() public method

Declare that the API key is located in the query
public IsInQuery ( ) : ApiKeySecuritySchemeBuilder
return ApiKeySecuritySchemeBuilder

Name() public method

The name.
public Name ( string name ) : ApiKeySecuritySchemeBuilder
name string /// The name. ///
return ApiKeySecuritySchemeBuilder