C# 클래스 RAML.WebApiExplorer.ApiExplorerService

파일 보기 프로젝트 열기: mulesoft-labs/raml-dotnet-apiexplorer 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
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