C# Класс RAML.WebApiExplorer.ApiExplorerService

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
RamlTypes	Raml.Parser.Expressions.RamlTypesOrderedDictionary
Schemas	string>.IDictionary
Types	ICollection

Открытые методы

Метод	Описание
ApiExplorerService ( IApiExplorer apiExplorer, string baseUri = null ) : System
GetRaml ( RamlVersion ramlVersion = RamlVersion.Version1, string title = null ) : Raml.Parser.Expressions.RamlDocument
SetSecurityScheme ( string type, Raml.Parser.Expressions.SecurityScheme scheme ) : void
UseOAuth1 ( string authorizationUri, string requestTokenUri, string tokenCredentialsUri, Raml.Parser.Expressions.SecuritySchemeDescriptor securitySchemeDescriptor ) : void
UseOAuth2 ( string authorizationUri, string accessTokenUri, IEnumerable authorizationGrants, IEnumerable scopes, Raml.Parser.Expressions.SecuritySchemeDescriptor securitySchemeDescriptor ) : void

Защищенные методы

Метод	Описание
AddType ( Type type ) : string
CreateJsonMimeType ( string type ) : MimeType>.Dictionary
CreateMimeType ( string type ) : Raml.Parser.Expressions.MimeType
CreateMimeTypes ( Raml.Parser.Expressions.MimeType mimeType ) : MimeType>.Dictionary
GetUniqueSchemaName ( string schemaName ) : string

Приватные методы

Метод	Описание
AddMethods ( Raml.Parser.Expressions.Resource resource, System.Web.Http.Description.ApiDescription api, ICollection verbs ) : void
GetDescription ( System.Web.Http.Description.ApiDescription api ) : string
GetMethods ( System.Web.Http.Description.ApiDescription api, ICollection verbs ) : IEnumerable
GetParameterFromProperty ( System.Web.Http.Description.ApiParameterDescription apiParam, PropertyInfo property ) : Raml.Parser.Expressions.Parameter
GetParametersFromComplexType ( System.Web.Http.Description.ApiParameterDescription apiParam, Parameter>.IDictionary queryParams ) : void
GetParametersFromUrl ( string url ) : Parameter>.IDictionary
GetPrimitiveParameter ( System.Web.Http.Description.ApiParameterDescription apiParam ) : Raml.Parser.Expressions.Parameter
GetQueryParameters ( IEnumerable parameterDescriptions ) : Parameter>.IDictionary
GetRequestMimeTypes ( System.Web.Http.Description.ApiDescription api ) : MimeType>.Dictionary
GetResponse ( Attribute attribute ) : Raml.Parser.Expressions.Response
GetResponses ( System.Web.Http.Description.ResponseDescription responseDescription, System.Web.Http.Description.ApiDescription api ) : IEnumerable
GetUriParameters ( string url, IEnumerable apiParameterDescriptions ) : Parameter>.IDictionary
HandleResponseTypeAttributes ( Type responseType ) : Raml.Parser.Expressions.Response
HandleResponseTypeStatusAttributes ( IEnumerable attributes ) : List
IsNullable ( Type type ) : bool
IsPrimitiveType ( Type parameterType ) : bool
OrganizeResourcesHierarchically ( Raml.Parser.Expressions.RamlDocument raml, Resource>.Dictionary resourcesDic ) : void
RemoveNonExistingParametersFromRoute ( string relativeUri, System.Web.Http.Description.ApiDescription api, string parameterName ) : string
SetSecurityScheme ( Raml.Parser.Expressions.RamlDocument raml ) : void
SetUriParameters ( IEnumerable resources, Dictionary parameterDescriptionsDic, string parentUrl ) : void

Описание методов

AddType() защищенный абстрактный Метод

protected abstract AddType ( Type type ) : string
type	System.Type
Результат	string

ApiExplorerService() публичный Метод

public ApiExplorerService ( IApiExplorer apiExplorer, string baseUri = null ) : System
apiExplorer	IApiExplorer
baseUri	string
Результат	System

CreateJsonMimeType() защищенный Метод

protected CreateJsonMimeType ( string type ) : MimeType>.Dictionary
type	string
Результат	MimeType>.Dictionary

CreateMimeType() защищенный абстрактный Метод

protected abstract CreateMimeType ( string type ) : Raml.Parser.Expressions.MimeType
type	string
Результат	Raml.Parser.Expressions.MimeType

CreateMimeTypes() защищенный Метод

protected CreateMimeTypes ( Raml.Parser.Expressions.MimeType mimeType ) : MimeType>.Dictionary
mimeType	Raml.Parser.Expressions.MimeType
Результат	MimeType>.Dictionary

GetRaml() публичный Метод

public GetRaml ( RamlVersion ramlVersion = RamlVersion.Version1, string title = null ) : Raml.Parser.Expressions.RamlDocument
ramlVersion	RamlVersion
title	string
Результат	Raml.Parser.Expressions.RamlDocument

GetUniqueSchemaName() защищенный Метод

protected GetUniqueSchemaName ( string schemaName ) : string
schemaName	string
Результат	string

SetSecurityScheme() публичный Метод

public SetSecurityScheme ( string type, Raml.Parser.Expressions.SecurityScheme scheme ) : void
type	string
scheme	Raml.Parser.Expressions.SecurityScheme
Результат	void

UseOAuth1() публичный Метод

public UseOAuth1 ( string authorizationUri, string requestTokenUri, string tokenCredentialsUri, Raml.Parser.Expressions.SecuritySchemeDescriptor securitySchemeDescriptor ) : void
authorizationUri	string
requestTokenUri	string
tokenCredentialsUri	string
securitySchemeDescriptor	Raml.Parser.Expressions.SecuritySchemeDescriptor
Результат	void

UseOAuth2() публичный Метод

public UseOAuth2 ( string authorizationUri, string accessTokenUri, IEnumerable authorizationGrants, IEnumerable scopes, Raml.Parser.Expressions.SecuritySchemeDescriptor securitySchemeDescriptor ) : void
authorizationUri	string
accessTokenUri	string
authorizationGrants	IEnumerable
scopes	IEnumerable
securitySchemeDescriptor	Raml.Parser.Expressions.SecuritySchemeDescriptor
Результат	void

Описание свойств

RamlTypes защищенное свойство

protected RamlTypesOrderedDictionary,Raml.Parser.Expressions RamlTypes
Результат	Raml.Parser.Expressions.RamlTypesOrderedDictionary

Schemas защищенное свойство

protected IDictionary Schemas
Результат	string>.IDictionary

Types защищенное свойство

protected ICollection Types
Результат	ICollection