C# 클래스 Swagger.Net.SwaggerGen

파일 보기 프로젝트 열기: giacomelli/DG-Swagger.Net 1 사용 예제들

공개 메소드들

메소드 설명
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

비공개 메소드들

메소드 설명
CreateAllowableValues ( Type type ) : ResourceModelPropertyAllowableValuesNode
CreateResourceModel ( System.Web.Http.Description.ApiParameterDescription param, Type modelType, XmlCommentDocumentationProvider docProvider ) : IList
SwaggerGen ( ) : System

Initializes the SwaggerGen class.

메소드 상세

CreateResourceApi() 공개 정적인 메소드

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
리턴 ResourceApi

CreateResourceApiOperation() 공개 정적인 메소드

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
리턴 ResourceApiOperation

CreateResourceApiOperationParameter() 공개 정적인 메소드

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
리턴 ResourceApiOperationParameter

CreateResourceListing() 공개 정적인 메소드

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
리턴 ResourceListing

CreateResourceListing() 공개 정적인 메소드

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
리턴 ResourceListing

CreateResourceModel() 공개 정적인 메소드

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

CreateResourceModel() 공개 정적인 메소드

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