C# Class Swagger.Net.SwaggerGen

Mostra file Open project: giacomelli/DG-Swagger.Net Class Usage Examples

Public Methods

Method	Description
CreateResourceApi ( System.Web.Http.Description.ApiDescription api ) : ResourceApi	Create an api element
CreateResourceApiOperation ( System.Web.Http.Description.ApiDescription api, XmlCommentDocumentationProvider docProvider ) : ResourceApiOperation	Creates an api operation
CreateResourceApiOperationParameter ( System.Web.Http.Description.ApiDescription api, System.Web.Http.Description.ApiParameterDescription param, XmlCommentDocumentationProvider docProvider ) : ResourceApiOperationParameter	Creates an operation parameter
CreateResourceListing ( System.Web.Http.Controllers.HttpActionContext actionContext, bool includeResourcePath = true ) : ResourceListing	Create a resource listing
CreateResourceListing ( System.Web.Http.Controllers.HttpControllerContext controllerContext, bool includeResourcePath = false ) : ResourceListing	Create a resource listing
CreateResourceModel ( System.Web.Http.Description.ApiParameterDescription param, XmlCommentDocumentationProvider docProvider ) : IList
CreateResourceModel ( Type modelType, XmlCommentDocumentationProvider docProvider ) : IList

Private Methods

Method	Description
CreateAllowableValues ( Type type ) : ResourceModelPropertyAllowableValuesNode
CreateResourceModel ( System.Web.Http.Description.ApiParameterDescription param, Type modelType, XmlCommentDocumentationProvider docProvider ) : IList
SwaggerGen ( ) : System	Initializes the SwaggerGen class.

Method Details

CreateResourceApi() public static method

Create an api element

public static CreateResourceApi ( System.Web.Http.Description.ApiDescription api ) : ResourceApi
api	System.Web.Http.Description.ApiDescription	Description of the api via the ApiExplorer
return	ResourceApi

CreateResourceApiOperation() public static method

Creates an api operation

public static CreateResourceApiOperation ( System.Web.Http.Description.ApiDescription api, XmlCommentDocumentationProvider docProvider ) : ResourceApiOperation
api	System.Web.Http.Description.ApiDescription	Description of the api via the ApiExplorer
docProvider	XmlCommentDocumentationProvider	Access to the XML docs written in code
return	ResourceApiOperation

CreateResourceApiOperationParameter() public static method

Creates an operation parameter

public static CreateResourceApiOperationParameter ( System.Web.Http.Description.ApiDescription api, System.Web.Http.Description.ApiParameterDescription param, XmlCommentDocumentationProvider docProvider ) : ResourceApiOperationParameter
api	System.Web.Http.Description.ApiDescription	Description of the api via the ApiExplorer
param	System.Web.Http.Description.ApiParameterDescription	Description of a parameter on an operation via the ApiExplorer
docProvider	XmlCommentDocumentationProvider	Access to the XML docs written in code
return	ResourceApiOperationParameter

CreateResourceListing() public static method

Create a resource listing

public static CreateResourceListing ( System.Web.Http.Controllers.HttpActionContext actionContext, bool includeResourcePath = true ) : ResourceListing
actionContext	System.Web.Http.Controllers.HttpActionContext	Current action context
includeResourcePath	bool	Should the resource path property be included in the response
return	ResourceListing

CreateResourceListing() public static method

Create a resource listing

public static CreateResourceListing ( System.Web.Http.Controllers.HttpControllerContext controllerContext, bool includeResourcePath = false ) : ResourceListing
controllerContext	System.Web.Http.Controllers.HttpControllerContext
includeResourcePath	bool	Should the resource path property be included in the response
return	ResourceListing

CreateResourceModel() public static method

public static CreateResourceModel ( System.Web.Http.Description.ApiParameterDescription param, XmlCommentDocumentationProvider docProvider ) : IList
param	System.Web.Http.Description.ApiParameterDescription
docProvider	XmlCommentDocumentationProvider
return	IList

CreateResourceModel() public static method

public static CreateResourceModel ( Type modelType, XmlCommentDocumentationProvider docProvider ) : IList
modelType	System.Type
docProvider	XmlCommentDocumentationProvider
return	IList