C# Class Apistry.WebApiDocumentationProvider

Inheritance: IDocumentationProvider
Show file Open project: Cephei/Apistry

Public Methods

Method Description
GetDocumentation ( HttpActionDescriptor httpActionDescriptor ) : String
GetDocumentation ( HttpParameterDescriptor httpParameterDescriptor ) : String
GetHttpActionDocumentation ( HttpActionDescriptor httpActionDescriptor ) : HttpActionDocumentation
WebApiDocumentationProvider ( WebApiDocumentationMetadata webApiDocumentationMetadata ) : System

Private Methods

Method Description
CreateDefaultControllerDocumentation ( HttpActionDescriptor actionDescriptor ) : HttpControllerDocumentation
CreateDefaultRequestBodyExample ( HttpActionDescriptor httpActionDescriptor, Type dto ) : Object
CreateDefaultRequestDocumentation ( HttpActionDescriptor actionDescriptor ) : HttpActionRequestDocumentation
CreateDefaultResponseDocumentation ( HttpActionDescriptor actionDescriptor ) : HttpActionResponseDocumentation
CreateHttpActionRequestBody ( HttpActionDescriptor httpActionDescriptor ) : Object
CreateHttpActionRequestDocumentation ( HttpActionDescriptor httpActionDescriptor, HttpActionDocumentationMetadata actionDocumentationMetadata ) : HttpActionRequestDocumentation
CreateHttpActionRequestParameters ( HttpActionDescriptor httpActionDescriptor, HttpActionDocumentationMetadata actionDocumentationMetadata ) : IEnumerable
CreateHttpActionResponseDocumentation ( HttpActionDocumentationMetadata actionDocumentationMetadata ) : HttpActionResponseDocumentation
CreateInstanceOfType ( Type type ) : Object
CreatePropertyDocumentation ( DtoDocumentationMetadata dtoDocumentationMetadata, String propertyPrefix ) : IEnumerable
CreateRequestBodyExample ( HttpActionDescriptor httpActionDescriptor, DtoDocumentationMetadata dtoDocumentationMetadata ) : Object
CreateResponseContentExample ( DtoDocumentationMetadata dtoDocumentationMetadata ) : Object
GetEnumerableType ( Type type ) : Type
GetPropertyNamePrefix ( PropertyDescriptor propertyDescriptor, String existingPrefix ) : String
GetProperyTypeName ( Type propertyType ) : String
GetResponseType ( Type type ) : Type

Method Details

GetDocumentation() public method

public GetDocumentation ( HttpActionDescriptor httpActionDescriptor ) : String
httpActionDescriptor HttpActionDescriptor
return String

GetDocumentation() public method

public GetDocumentation ( HttpParameterDescriptor httpParameterDescriptor ) : String
httpParameterDescriptor HttpParameterDescriptor
return String

GetHttpActionDocumentation() public method

public GetHttpActionDocumentation ( HttpActionDescriptor httpActionDescriptor ) : HttpActionDocumentation
httpActionDescriptor HttpActionDescriptor
return Apistry.ApiController.HttpActionDocumentation

WebApiDocumentationProvider() public method

public WebApiDocumentationProvider ( WebApiDocumentationMetadata webApiDocumentationMetadata ) : System
webApiDocumentationMetadata WebApiDocumentationMetadata
return System