<?xml version="1.0"?>
|
<doc>
|
<assembly>
|
<name>VueWebApi</name>
|
</assembly>
|
<members>
|
<member name="M:VueWebApi.SwaggerConfig.GetXmlCommentsPath(System.String)">
|
<summary>
|
XML路径拼接
|
</summary>
|
<param name="name"></param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.ApiDescriptionExtensions.GetFriendlyId(System.Web.Http.Description.ApiDescription)">
|
<summary>
|
Generates an URI-friendly ID for the <see cref="T:System.Web.Http.Description.ApiDescription"/>. E.g. "Get-Values-id_name" instead of "GetValues/{id}?name={name}"
|
</summary>
|
<param name="description">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
|
<returns>The ID as a string.</returns>
|
</member>
|
<member name="T:VueWebApi.Areas.HelpPage.HelpPageConfig">
|
<summary>
|
Use this class to customize the Help Page.
|
For example you can set a custom <see cref="T:System.Web.Http.Description.IDocumentationProvider"/> to supply the documentation
|
or you can provide the samples for the requests/responses.
|
</summary>
|
</member>
|
<member name="T:VueWebApi.Areas.HelpPage.Controllers.HelpController">
|
<summary>
|
The controller that will handle requests for the help page.
|
</summary>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageConfigurationExtensions.SetDocumentationProvider(System.Web.Http.HttpConfiguration,System.Web.Http.Description.IDocumentationProvider)">
|
<summary>
|
Sets the documentation provider for help page.
|
</summary>
|
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
|
<param name="documentationProvider">The documentation provider.</param>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleObjects(System.Web.Http.HttpConfiguration,System.Collections.Generic.IDictionary{System.Type,System.Object})">
|
<summary>
|
Sets the objects that will be used by the formatters to produce sample requests/responses.
|
</summary>
|
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
|
<param name="sampleObjects">The sample objects.</param>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleRequest(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.String,System.String)">
|
<summary>
|
Sets the sample request directly for the specified media type and action.
|
</summary>
|
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
|
<param name="sample">The sample request.</param>
|
<param name="mediaType">The media type.</param>
|
<param name="controllerName">Name of the controller.</param>
|
<param name="actionName">Name of the action.</param>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleRequest(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.String,System.String,System.String[])">
|
<summary>
|
Sets the sample request directly for the specified media type and action with parameters.
|
</summary>
|
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
|
<param name="sample">The sample request.</param>
|
<param name="mediaType">The media type.</param>
|
<param name="controllerName">Name of the controller.</param>
|
<param name="actionName">Name of the action.</param>
|
<param name="parameterNames">The parameter names.</param>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleResponse(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.String,System.String)">
|
<summary>
|
Sets the sample request directly for the specified media type of the action.
|
</summary>
|
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
|
<param name="sample">The sample response.</param>
|
<param name="mediaType">The media type.</param>
|
<param name="controllerName">Name of the controller.</param>
|
<param name="actionName">Name of the action.</param>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleResponse(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.String,System.String,System.String[])">
|
<summary>
|
Sets the sample response directly for the specified media type of the action with specific parameters.
|
</summary>
|
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
|
<param name="sample">The sample response.</param>
|
<param name="mediaType">The media type.</param>
|
<param name="controllerName">Name of the controller.</param>
|
<param name="actionName">Name of the action.</param>
|
<param name="parameterNames">The parameter names.</param>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleForMediaType(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue)">
|
<summary>
|
Sets the sample directly for all actions with the specified media type.
|
</summary>
|
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
|
<param name="sample">The sample.</param>
|
<param name="mediaType">The media type.</param>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleForType(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.Type)">
|
<summary>
|
Sets the sample directly for all actions with the specified type and media type.
|
</summary>
|
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
|
<param name="sample">The sample.</param>
|
<param name="mediaType">The media type.</param>
|
<param name="type">The parameter type or return type of an action.</param>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageConfigurationExtensions.SetActualRequestType(System.Web.Http.HttpConfiguration,System.Type,System.String,System.String)">
|
<summary>
|
Specifies the actual type of <see cref="T:System.Net.Http.ObjectContent`1"/> passed to the <see cref="T:System.Net.Http.HttpRequestMessage"/> in an action.
|
The help page will use this information to produce more accurate request samples.
|
</summary>
|
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
|
<param name="type">The type.</param>
|
<param name="controllerName">Name of the controller.</param>
|
<param name="actionName">Name of the action.</param>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageConfigurationExtensions.SetActualRequestType(System.Web.Http.HttpConfiguration,System.Type,System.String,System.String,System.String[])">
|
<summary>
|
Specifies the actual type of <see cref="T:System.Net.Http.ObjectContent`1"/> passed to the <see cref="T:System.Net.Http.HttpRequestMessage"/> in an action.
|
The help page will use this information to produce more accurate request samples.
|
</summary>
|
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
|
<param name="type">The type.</param>
|
<param name="controllerName">Name of the controller.</param>
|
<param name="actionName">Name of the action.</param>
|
<param name="parameterNames">The parameter names.</param>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageConfigurationExtensions.SetActualResponseType(System.Web.Http.HttpConfiguration,System.Type,System.String,System.String)">
|
<summary>
|
Specifies the actual type of <see cref="T:System.Net.Http.ObjectContent`1"/> returned as part of the <see cref="T:System.Net.Http.HttpRequestMessage"/> in an action.
|
The help page will use this information to produce more accurate response samples.
|
</summary>
|
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
|
<param name="type">The type.</param>
|
<param name="controllerName">Name of the controller.</param>
|
<param name="actionName">Name of the action.</param>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageConfigurationExtensions.SetActualResponseType(System.Web.Http.HttpConfiguration,System.Type,System.String,System.String,System.String[])">
|
<summary>
|
Specifies the actual type of <see cref="T:System.Net.Http.ObjectContent`1"/> returned as part of the <see cref="T:System.Net.Http.HttpRequestMessage"/> in an action.
|
The help page will use this information to produce more accurate response samples.
|
</summary>
|
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
|
<param name="type">The type.</param>
|
<param name="controllerName">Name of the controller.</param>
|
<param name="actionName">Name of the action.</param>
|
<param name="parameterNames">The parameter names.</param>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageConfigurationExtensions.GetHelpPageSampleGenerator(System.Web.Http.HttpConfiguration)">
|
<summary>
|
Gets the help page sample generator.
|
</summary>
|
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
|
<returns>The help page sample generator.</returns>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageConfigurationExtensions.SetHelpPageSampleGenerator(System.Web.Http.HttpConfiguration,VueWebApi.Areas.HelpPage.HelpPageSampleGenerator)">
|
<summary>
|
Sets the help page sample generator.
|
</summary>
|
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
|
<param name="sampleGenerator">The help page sample generator.</param>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageConfigurationExtensions.GetModelDescriptionGenerator(System.Web.Http.HttpConfiguration)">
|
<summary>
|
Gets the model description generator.
|
</summary>
|
<param name="config">The configuration.</param>
|
<returns>The <see cref="T:VueWebApi.Areas.HelpPage.ModelDescriptions.ModelDescriptionGenerator"/></returns>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageConfigurationExtensions.GetHelpPageApiModel(System.Web.Http.HttpConfiguration,System.String)">
|
<summary>
|
Gets the model that represents an API displayed on the help page. The model is initialized on the first call and cached for subsequent calls.
|
</summary>
|
<param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
|
<param name="apiDescriptionId">The <see cref="T:System.Web.Http.Description.ApiDescription"/> ID.</param>
|
<returns>
|
An <see cref="T:VueWebApi.Areas.HelpPage.Models.HelpPageApiModel"/>
|
</returns>
|
</member>
|
<member name="T:VueWebApi.Areas.HelpPage.ModelDescriptions.ModelDescription">
|
<summary>
|
Describes a type model.
|
</summary>
|
</member>
|
<member name="T:VueWebApi.Areas.HelpPage.ModelDescriptions.ModelDescriptionGenerator">
|
<summary>
|
Generates model descriptions for given types.
|
</summary>
|
</member>
|
<member name="T:VueWebApi.Areas.HelpPage.ModelDescriptions.ModelNameAttribute">
|
<summary>
|
Use this attribute to change the name of the <see cref="T:VueWebApi.Areas.HelpPage.ModelDescriptions.ModelDescription"/> generated for a type.
|
</summary>
|
</member>
|
<member name="T:VueWebApi.Areas.HelpPage.Models.HelpPageApiModel">
|
<summary>
|
The model that represents an API displayed on the help page.
|
</summary>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.Models.HelpPageApiModel.#ctor">
|
<summary>
|
Initializes a new instance of the <see cref="T:VueWebApi.Areas.HelpPage.Models.HelpPageApiModel"/> class.
|
</summary>
|
</member>
|
<member name="P:VueWebApi.Areas.HelpPage.Models.HelpPageApiModel.ApiDescription">
|
<summary>
|
Gets or sets the <see cref="P:VueWebApi.Areas.HelpPage.Models.HelpPageApiModel.ApiDescription"/> that describes the API.
|
</summary>
|
</member>
|
<member name="P:VueWebApi.Areas.HelpPage.Models.HelpPageApiModel.UriParameters">
|
<summary>
|
Gets or sets the <see cref="T:VueWebApi.Areas.HelpPage.ModelDescriptions.ParameterDescription"/> collection that describes the URI parameters for the API.
|
</summary>
|
</member>
|
<member name="P:VueWebApi.Areas.HelpPage.Models.HelpPageApiModel.RequestDocumentation">
|
<summary>
|
Gets or sets the documentation for the request.
|
</summary>
|
</member>
|
<member name="P:VueWebApi.Areas.HelpPage.Models.HelpPageApiModel.RequestModelDescription">
|
<summary>
|
Gets or sets the <see cref="T:VueWebApi.Areas.HelpPage.ModelDescriptions.ModelDescription"/> that describes the request body.
|
</summary>
|
</member>
|
<member name="P:VueWebApi.Areas.HelpPage.Models.HelpPageApiModel.RequestBodyParameters">
|
<summary>
|
Gets the request body parameter descriptions.
|
</summary>
|
</member>
|
<member name="P:VueWebApi.Areas.HelpPage.Models.HelpPageApiModel.ResourceDescription">
|
<summary>
|
Gets or sets the <see cref="T:VueWebApi.Areas.HelpPage.ModelDescriptions.ModelDescription"/> that describes the resource.
|
</summary>
|
</member>
|
<member name="P:VueWebApi.Areas.HelpPage.Models.HelpPageApiModel.ResourceProperties">
|
<summary>
|
Gets the resource property descriptions.
|
</summary>
|
</member>
|
<member name="P:VueWebApi.Areas.HelpPage.Models.HelpPageApiModel.SampleRequests">
|
<summary>
|
Gets the sample requests associated with the API.
|
</summary>
|
</member>
|
<member name="P:VueWebApi.Areas.HelpPage.Models.HelpPageApiModel.SampleResponses">
|
<summary>
|
Gets the sample responses associated with the API.
|
</summary>
|
</member>
|
<member name="P:VueWebApi.Areas.HelpPage.Models.HelpPageApiModel.ErrorMessages">
|
<summary>
|
Gets the error messages associated with this model.
|
</summary>
|
</member>
|
<member name="T:VueWebApi.Areas.HelpPage.HelpPageSampleGenerator">
|
<summary>
|
This class will generate the samples for the help page.
|
</summary>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageSampleGenerator.#ctor">
|
<summary>
|
Initializes a new instance of the <see cref="T:VueWebApi.Areas.HelpPage.HelpPageSampleGenerator"/> class.
|
</summary>
|
</member>
|
<member name="P:VueWebApi.Areas.HelpPage.HelpPageSampleGenerator.ActualHttpMessageTypes">
|
<summary>
|
Gets CLR types that are used as the content of <see cref="T:System.Net.Http.HttpRequestMessage"/> or <see cref="T:System.Net.Http.HttpResponseMessage"/>.
|
</summary>
|
</member>
|
<member name="P:VueWebApi.Areas.HelpPage.HelpPageSampleGenerator.ActionSamples">
|
<summary>
|
Gets the objects that are used directly as samples for certain actions.
|
</summary>
|
</member>
|
<member name="P:VueWebApi.Areas.HelpPage.HelpPageSampleGenerator.SampleObjects">
|
<summary>
|
Gets the objects that are serialized as samples by the supported formatters.
|
</summary>
|
</member>
|
<member name="P:VueWebApi.Areas.HelpPage.HelpPageSampleGenerator.SampleObjectFactories">
|
<summary>
|
Gets factories for the objects that the supported formatters will serialize as samples. Processed in order,
|
stopping when the factory successfully returns a non-<see langref="null"/> object.
|
</summary>
|
<remarks>
|
Collection includes just <see cref="M:VueWebApi.Areas.HelpPage.ObjectGenerator.GenerateObject(System.Type)"/> initially. Use
|
<code>SampleObjectFactories.Insert(0, func)</code> to provide an override and
|
<code>SampleObjectFactories.Add(func)</code> to provide a fallback.</remarks>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageSampleGenerator.GetSampleRequests(System.Web.Http.Description.ApiDescription)">
|
<summary>
|
Gets the request body samples for a given <see cref="T:System.Web.Http.Description.ApiDescription"/>.
|
</summary>
|
<param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
|
<returns>The samples keyed by media type.</returns>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageSampleGenerator.GetSampleResponses(System.Web.Http.Description.ApiDescription)">
|
<summary>
|
Gets the response body samples for a given <see cref="T:System.Web.Http.Description.ApiDescription"/>.
|
</summary>
|
<param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
|
<returns>The samples keyed by media type.</returns>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageSampleGenerator.GetSample(System.Web.Http.Description.ApiDescription,VueWebApi.Areas.HelpPage.SampleDirection)">
|
<summary>
|
Gets the request or response body samples.
|
</summary>
|
<param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
|
<param name="sampleDirection">The value indicating whether the sample is for a request or for a response.</param>
|
<returns>The samples keyed by media type.</returns>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageSampleGenerator.GetActionSample(System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.Type,System.Net.Http.Formatting.MediaTypeFormatter,System.Net.Http.Headers.MediaTypeHeaderValue,VueWebApi.Areas.HelpPage.SampleDirection)">
|
<summary>
|
Search for samples that are provided directly through <see cref="P:VueWebApi.Areas.HelpPage.HelpPageSampleGenerator.ActionSamples"/>.
|
</summary>
|
<param name="controllerName">Name of the controller.</param>
|
<param name="actionName">Name of the action.</param>
|
<param name="parameterNames">The parameter names.</param>
|
<param name="type">The CLR type.</param>
|
<param name="formatter">The formatter.</param>
|
<param name="mediaType">The media type.</param>
|
<param name="sampleDirection">The value indicating whether the sample is for a request or for a response.</param>
|
<returns>The sample that matches the parameters.</returns>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageSampleGenerator.GetSampleObject(System.Type)">
|
<summary>
|
Gets the sample object that will be serialized by the formatters.
|
First, it will look at the <see cref="P:VueWebApi.Areas.HelpPage.HelpPageSampleGenerator.SampleObjects"/>. If no sample object is found, it will try to create
|
one using <see cref="M:VueWebApi.Areas.HelpPage.HelpPageSampleGenerator.DefaultSampleObjectFactory(VueWebApi.Areas.HelpPage.HelpPageSampleGenerator,System.Type)"/> (which wraps an <see cref="T:VueWebApi.Areas.HelpPage.ObjectGenerator"/>) and other
|
factories in <see cref="P:VueWebApi.Areas.HelpPage.HelpPageSampleGenerator.SampleObjectFactories"/>.
|
</summary>
|
<param name="type">The type.</param>
|
<returns>The sample object.</returns>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageSampleGenerator.ResolveHttpRequestMessageType(System.Web.Http.Description.ApiDescription)">
|
<summary>
|
Resolves the actual type of <see cref="T:System.Net.Http.ObjectContent`1"/> passed to the <see cref="T:System.Net.Http.HttpRequestMessage"/> in an action.
|
</summary>
|
<param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
|
<returns>The type.</returns>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageSampleGenerator.ResolveType(System.Web.Http.Description.ApiDescription,System.String,System.String,System.Collections.Generic.IEnumerable{System.String},VueWebApi.Areas.HelpPage.SampleDirection,System.Collections.ObjectModel.Collection{System.Net.Http.Formatting.MediaTypeFormatter}@)">
|
<summary>
|
Resolves the type of the action parameter or return value when <see cref="T:System.Net.Http.HttpRequestMessage"/> or <see cref="T:System.Net.Http.HttpResponseMessage"/> is used.
|
</summary>
|
<param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
|
<param name="controllerName">Name of the controller.</param>
|
<param name="actionName">Name of the action.</param>
|
<param name="parameterNames">The parameter names.</param>
|
<param name="sampleDirection">The value indicating whether the sample is for a request or a response.</param>
|
<param name="formatters">The formatters.</param>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageSampleGenerator.WriteSampleObjectUsingFormatter(System.Net.Http.Formatting.MediaTypeFormatter,System.Object,System.Type,System.Net.Http.Headers.MediaTypeHeaderValue)">
|
<summary>
|
Writes the sample object using formatter.
|
</summary>
|
<param name="formatter">The formatter.</param>
|
<param name="value">The value.</param>
|
<param name="type">The type.</param>
|
<param name="mediaType">Type of the media.</param>
|
<returns></returns>
|
</member>
|
<member name="T:VueWebApi.Areas.HelpPage.HelpPageSampleKey">
|
<summary>
|
This is used to identify the place where the sample should be applied.
|
</summary>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageSampleKey.#ctor(System.Net.Http.Headers.MediaTypeHeaderValue)">
|
<summary>
|
Creates a new <see cref="T:VueWebApi.Areas.HelpPage.HelpPageSampleKey"/> based on media type.
|
</summary>
|
<param name="mediaType">The media type.</param>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageSampleKey.#ctor(System.Net.Http.Headers.MediaTypeHeaderValue,System.Type)">
|
<summary>
|
Creates a new <see cref="T:VueWebApi.Areas.HelpPage.HelpPageSampleKey"/> based on media type and CLR type.
|
</summary>
|
<param name="mediaType">The media type.</param>
|
<param name="type">The CLR type.</param>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageSampleKey.#ctor(VueWebApi.Areas.HelpPage.SampleDirection,System.String,System.String,System.Collections.Generic.IEnumerable{System.String})">
|
<summary>
|
Creates a new <see cref="T:VueWebApi.Areas.HelpPage.HelpPageSampleKey"/> based on <see cref="P:VueWebApi.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>, controller name, action name and parameter names.
|
</summary>
|
<param name="sampleDirection">The <see cref="P:VueWebApi.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>.</param>
|
<param name="controllerName">Name of the controller.</param>
|
<param name="actionName">Name of the action.</param>
|
<param name="parameterNames">The parameter names.</param>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.HelpPageSampleKey.#ctor(System.Net.Http.Headers.MediaTypeHeaderValue,VueWebApi.Areas.HelpPage.SampleDirection,System.String,System.String,System.Collections.Generic.IEnumerable{System.String})">
|
<summary>
|
Creates a new <see cref="T:VueWebApi.Areas.HelpPage.HelpPageSampleKey"/> based on media type, <see cref="P:VueWebApi.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>, controller name, action name and parameter names.
|
</summary>
|
<param name="mediaType">The media type.</param>
|
<param name="sampleDirection">The <see cref="P:VueWebApi.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>.</param>
|
<param name="controllerName">Name of the controller.</param>
|
<param name="actionName">Name of the action.</param>
|
<param name="parameterNames">The parameter names.</param>
|
</member>
|
<member name="P:VueWebApi.Areas.HelpPage.HelpPageSampleKey.ControllerName">
|
<summary>
|
Gets the name of the controller.
|
</summary>
|
<value>
|
The name of the controller.
|
</value>
|
</member>
|
<member name="P:VueWebApi.Areas.HelpPage.HelpPageSampleKey.ActionName">
|
<summary>
|
Gets the name of the action.
|
</summary>
|
<value>
|
The name of the action.
|
</value>
|
</member>
|
<member name="P:VueWebApi.Areas.HelpPage.HelpPageSampleKey.MediaType">
|
<summary>
|
Gets the media type.
|
</summary>
|
<value>
|
The media type.
|
</value>
|
</member>
|
<member name="P:VueWebApi.Areas.HelpPage.HelpPageSampleKey.ParameterNames">
|
<summary>
|
Gets the parameter names.
|
</summary>
|
</member>
|
<member name="P:VueWebApi.Areas.HelpPage.HelpPageSampleKey.SampleDirection">
|
<summary>
|
Gets the <see cref="P:VueWebApi.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>.
|
</summary>
|
</member>
|
<member name="T:VueWebApi.Areas.HelpPage.ImageSample">
|
<summary>
|
This represents an image sample on the help page. There's a display template named ImageSample associated with this class.
|
</summary>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.ImageSample.#ctor(System.String)">
|
<summary>
|
Initializes a new instance of the <see cref="T:VueWebApi.Areas.HelpPage.ImageSample"/> class.
|
</summary>
|
<param name="src">The URL of an image.</param>
|
</member>
|
<member name="T:VueWebApi.Areas.HelpPage.InvalidSample">
|
<summary>
|
This represents an invalid sample on the help page. There's a display template named InvalidSample associated with this class.
|
</summary>
|
</member>
|
<member name="T:VueWebApi.Areas.HelpPage.ObjectGenerator">
|
<summary>
|
This class will create an object of a given type and populate it with sample data.
|
</summary>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.ObjectGenerator.GenerateObject(System.Type)">
|
<summary>
|
Generates an object for a given type. The type needs to be public, have a public default constructor and settable public properties/fields. Currently it supports the following types:
|
Simple types: <see cref="T:System.Int32"/>, <see cref="T:System.String"/>, <see cref="T:System.Enum"/>, <see cref="T:System.DateTime"/>, <see cref="T:System.Uri"/>, etc.
|
Complex types: POCO types.
|
Nullables: <see cref="T:System.Nullable`1"/>.
|
Arrays: arrays of simple types or complex types.
|
Key value pairs: <see cref="T:System.Collections.Generic.KeyValuePair`2"/>
|
Tuples: <see cref="T:System.Tuple`1"/>, <see cref="T:System.Tuple`2"/>, etc
|
Dictionaries: <see cref="T:System.Collections.Generic.IDictionary`2"/> or anything deriving from <see cref="T:System.Collections.Generic.IDictionary`2"/>.
|
Collections: <see cref="T:System.Collections.Generic.IList`1"/>, <see cref="T:System.Collections.Generic.IEnumerable`1"/>, <see cref="T:System.Collections.Generic.ICollection`1"/>, <see cref="T:System.Collections.IList"/>, <see cref="T:System.Collections.IEnumerable"/>, <see cref="T:System.Collections.ICollection"/> or anything deriving from <see cref="T:System.Collections.Generic.ICollection`1"/> or <see cref="T:System.Collections.IList"/>.
|
Queryables: <see cref="T:System.Linq.IQueryable"/>, <see cref="T:System.Linq.IQueryable`1"/>.
|
</summary>
|
<param name="type">The type.</param>
|
<returns>An object of the given type.</returns>
|
</member>
|
<member name="T:VueWebApi.Areas.HelpPage.SampleDirection">
|
<summary>
|
Indicates whether the sample is used for request or response
|
</summary>
|
</member>
|
<member name="T:VueWebApi.Areas.HelpPage.TextSample">
|
<summary>
|
This represents a preformatted text sample on the help page. There's a display template named TextSample associated with this class.
|
</summary>
|
</member>
|
<member name="T:VueWebApi.Areas.HelpPage.XmlDocumentationProvider">
|
<summary>
|
A custom <see cref="T:System.Web.Http.Description.IDocumentationProvider"/> that reads the API documentation from an XML documentation file.
|
</summary>
|
</member>
|
<member name="M:VueWebApi.Areas.HelpPage.XmlDocumentationProvider.#ctor(System.String)">
|
<summary>
|
Initializes a new instance of the <see cref="T:VueWebApi.Areas.HelpPage.XmlDocumentationProvider"/> class.
|
</summary>
|
<param name="documentPath">The physical path to XML document.</param>
|
</member>
|
<member name="M:VueWebApi.Controllers.BasicSettingController.OrganizationSearch(System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.String,System.String)">
|
<summary>
|
组织架构查询
|
</summary>
|
<param name="OrgCode">组织架构代码</param>
|
<param name="OrgName">组织架构名称</param>
|
<param name="OrgType">组织类型</param>
|
<param name="UserName">创建人员</param>
|
<param name="page">页码</param>
|
<param name="rows">每页显示条数</param>
|
<param name="prop">排序字段</param>
|
<param name="order">排序规则</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.BasicSettingController.PrentOrganization(System.String)">
|
<summary>
|
组织架构查找上级单位
|
</summary>
|
<param name="orgcode">组织编码</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.BasicSettingController.AddUpdateOrganization(Newtonsoft.Json.Linq.JObject)">
|
<summary>
|
组织架构新增编辑
|
</summary>
|
<param name="obj">提交数据对象</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.BasicSettingController.DeleteOrganization(System.Int32)">
|
<summary>
|
组织架构删除
|
</summary>
|
<param name="orgid">组织id</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.BasicSettingController.UserSearch(System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.String,System.String)">
|
<summary>
|
用户清单查询
|
</summary>
|
<param name="UserCode">用户编码</param>
|
<param name="UserName">用户名称</param>
|
<param name="StuOrg">所属组织</param>
|
<param name="Enable">在职状态</param>
|
<param name="page">页码</param>
|
<param name="rows">每页显示条数</param>
|
<param name="prop">排序字段</param>
|
<param name="order">排序规则</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.BasicSettingController.UserOrganization">
|
<summary>
|
用户所属组织查询
|
</summary>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.BasicSettingController.AddUpdateUser(Newtonsoft.Json.Linq.JObject)">
|
<summary>
|
用户清单新增编辑
|
</summary>
|
<param name="obj">提交数据对象</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.BasicSettingController.DeleteUser(System.Int32)">
|
<summary>
|
用户删除
|
</summary>
|
<param name="Userid">用户id</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.BasicSettingController.UserAssociationRole(System.String)">
|
<summary>
|
用户清单关联角色查询
|
</summary>
|
<param name="usercode">用户编码</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.BasicSettingController.SaveUserAssoctRole(System.String,System.Collections.Generic.List{VueWebApi.Models.RoleUserSubmit})">
|
<summary>
|
用户清单关联角色保存
|
</summary>
|
<param name="usercode">用户编码</param>
|
<param name="json">提交数据对象</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.BasicSettingController.RoleTypeSearch(System.Int32,System.Int32,System.String,System.String)">
|
<summary>
|
角色类型查询
|
</summary>
|
<param name="page">页码</param>
|
<param name="rows">每页显示条数</param>
|
<param name="prop">排序字段</param>
|
<param name="order">排序规则</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.BasicSettingController.RoleTypeAdd(System.Collections.Generic.List{VueWebApi.Models.ObjectData})">
|
<summary>
|
角色类型新增
|
</summary>
|
<param name="json">角色类型提交数据</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.BasicSettingController.RoleTypeDelete(System.String)">
|
<summary>
|
角色类型删除
|
</summary>
|
<param name="RoleTypeCode">角色类型编码</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.BasicSettingController.RoleSearch(System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.String,System.String)">
|
<summary>
|
角色清单查询
|
</summary>
|
<param name="RoleCode">角色编码</param>
|
<param name="RoleName">角色名称</param>
|
<param name="RoleTypeCode">角色类型编码</param>
|
<param name="CreateUser">创建人员</param>
|
<param name="page">页码</param>
|
<param name="rows">每页显示条数</param>
|
<param name="prop">排序字段</param>
|
<param name="order">排序规则</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.BasicSettingController.AddUpdateRole(Newtonsoft.Json.Linq.JObject)">
|
<summary>
|
角色清单新增编辑
|
</summary>
|
<param name="obj">提交数据对象</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.BasicSettingController.DeleteRole(System.String)">
|
<summary>
|
角色清单删除
|
</summary>
|
<param name="RoleCode">角色编码</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.BasicSettingController.RoleAssociationUser(System.String)">
|
<summary>
|
角色清单关联用户查询
|
</summary>
|
<param name="rolecode">角色编码</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.LoginController.LoginSave(System.String,System.String)">
|
<summary>
|
用户登录
|
</summary>
|
<param name="username">用户名</param>
|
<param name="password">密码</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.LoginController.LoginMenu">
|
<summary>
|
查询功能菜单
|
</summary>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.LoginController.UpdateUserPassword(System.String,System.String,System.String)">
|
<summary>
|
修改密码
|
</summary>
|
<param name="username">用户名</param>
|
<param name="password">密码</param>
|
<param name="newpassword">新密码</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.SystemSettingController.EncodingRules(System.String,System.String,System.Int32,System.Int32,System.String,System.String)">
|
<summary>
|
编码规则查询
|
</summary>
|
<param name="rightname">编码名称</param>
|
<param name="prefix">固定字符</param>
|
<param name="page">页码</param>
|
<param name="rows">每页显示条数</param>
|
<param name="prop">排序字段</param>
|
<param name="order">排序规则</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.SystemSettingController.SaveEncodingRules(Newtonsoft.Json.Linq.JObject)">
|
<summary>
|
编码规则编辑保存
|
</summary>
|
<param name="obj">提交数据对象</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Controllers.SystemSettingController.NewEncodingRules(System.String)">
|
<summary>
|
获取规则生成的编码
|
</summary>
|
<param name="rightcode">功能编码</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.WebApiApplication.Init">
|
<summary>
|
注册Session
|
</summary>
|
</member>
|
<member name="T:VueWebApi.Tools.ChannelActionFilterAttribute">
|
<summary>
|
渠道过滤器
|
</summary>
|
</member>
|
<member name="M:VueWebApi.Tools.ChannelActionFilterAttribute.OnActionExecuting(System.Web.Http.Controllers.HttpActionContext)">
|
<summary>
|
请求接口之前渠道过滤
|
</summary>
|
<param name="actionContext"></param>
|
</member>
|
<member name="M:VueWebApi.Tools.DapperHelper.sqlConnection">
|
<summary>
|
创建数据库连接对象Sqlserver
|
</summary>
|
<returns></returns>
|
</member>
|
<!-- Badly formed XML comment ignored for member "M:VueWebApi.Tools.DapperHelper.select``1(System.String,System.Object)" -->
|
<member name="M:VueWebApi.Tools.DapperHelper.selectToDict(System.String,System.Object)">
|
<summary>
|
Dapper查询返回List字典对象 无需手动Wapper对象了
|
</summary>
|
<param name="sql"></param>
|
<param name="parm"></param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DapperHelper.selectToObject``1(System.String,System.Object)">
|
<summary>
|
Dapper查询返回对象非List集合
|
</summary>
|
<typeparam name="T"></typeparam>
|
<param name="sql"></param>
|
<param name="parm"></param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DapperHelper.GetPageList``1(System.String,System.Object,System.String,System.String,System.Int32,System.Int32,System.Int32@)">
|
<summary>
|
dapper通用分页函数
|
</summary>
|
<typeparam name="T">泛型集合实体类</typeparam>
|
<param name="sql">查询语句</param>
|
<param name="orderBy">排序（字段 DESC/ASC）</param>
|
<param name="pageIndex">当前页</param>
|
<param name="pageSize">当前页显示条数</param>
|
<param name="total">结果集总数</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DapperHelper.selectdata(System.String,System.Object)">
|
<summary>
|
Dapper查询返回datatable数据(带参数)
|
</summary>
|
<param name="sql"></param>
|
<param name="parm"></param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DapperHelper.selecttable(System.String)">
|
<summary>
|
Dapper查询返回datatable数据(不带参数)
|
</summary>
|
<param name="sql"></param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DapperHelper.selectcount(System.String,System.Object)">
|
<summary>
|
Dapper查询返回数据条数
|
</summary>
|
<param name="sql"></param>
|
<param name="parm"></param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DapperHelper.SQL(System.String,System.Object)">
|
<summary>
|
Dapper增删改
|
</summary>
|
<param name="sql"></param>
|
<param name="parametere"></param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DapperHelper.DoTransaction(System.Collections.Generic.List{System.Object})">
|
<summary>
|
增加，删除，修改使用的 事务方法 Sqllist为依次执行
|
</summary>
|
<param name="sqlList"></param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DapperHelper.insertReturnId(System.String,System.Object,System.String)">
|
<summary>
|
Dapper插入 返回自增主键Id
|
</summary>
|
<param name="sql"></param>
|
<param name="parameter"></param>
|
<param name="tableName">待插入数据的表名</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DataOperator.ExecuteSqlTran(System.Collections.Generic.List{System.String},System.Data.SqlClient.SqlParameter[])">
|
<summary>
|
执行多条SQL语句，实现数据库事务。
|
</summary>
|
<param name="sql">多条SQL语句</param>
|
<returns>影响的记录数</returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DBHelper.GetTable(System.String)">
|
<summary>
|
获取DataTable
|
</summary>
|
<param name="sql">传入SQL语句</param>
|
<returns>返回DataTable</returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DBHelper.GetTable(System.String,System.Data.SqlClient.SqlParameter[])">
|
<summary>
|
获取DataTable
|
</summary>
|
<param name="sql">传入SQL语句</param>
|
<param name="parameters">SqlParameter 参数</param>
|
<returns>返回DataTable</returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DBHelper.GetData(System.String,System.Data.SqlClient.SqlParameter[])">
|
<summary>
|
Dataset获取数据表
|
</summary>
|
<param name="sql"></param>
|
<param name="parameters"></param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DBHelper.GetCount(System.String)">
|
<summary>
|
获取数据行数,如果出错返回"-1"
|
</summary>
|
<param name="sql">传入SQL语句</param>
|
<returns>如果出错返回"-1"</returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DBHelper.Executesqltran(System.Collections.Generic.List{System.String},System.Data.SqlClient.SqlParameter[])">
|
<summary>
|
执行多条sql语句的事物
|
</summary>
|
<param name="list"></param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DBHelper.GetCount(System.String,System.Data.SqlClient.SqlParameter[])">
|
<summary>
|
获取数据行数,如果出错返回"-1"
|
</summary>
|
<param name="sql">传入SQL语句</param>
|
<param name="parameters">SqlParameter 参数</param>
|
<returns>如果出错返回"-1"</returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DBHelper.GetObject(System.String)">
|
<summary>
|
获取表格第一行第一列
|
</summary>
|
<param name="sql">传入SQL语句</param>
|
<returns>如果出错返回"null"</returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DBHelper.GetObject(System.String,System.Data.SqlClient.SqlParameter[])">
|
<summary>
|
获取表格第一行第一列
|
</summary>
|
<param name="sql">传入SQL语句</param>
|
<param name="parameters">SqlParameter 参数</param>
|
<returns>返回Object</returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DBHelper.ExecuteSql(System.String)">
|
<summary>
|
执行SQL语句返回是否成功
|
</summary>
|
<param name="sql">传入SQL语句</param>
|
<returns>返回是否成功</returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DBHelper.ExecuteSql(System.String,System.Data.SqlClient.SqlParameter[])">
|
<summary>
|
执行SQL语句返回是否成功
|
</summary>
|
<param name="sql">传入SQL语句</param>
|
<param name="parameters">SqlParameter 参数</param>
|
<returns>返回是否成功</returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DBHelper.ExecuteProduct(System.String,System.Data.SqlClient.SqlParameter[])">
|
<summary>
|
执行存储过程返回返回值
|
</summary>
|
<param name="productName">存储过程名字</param>
|
<param name="parameters">SqlParameter 参数</param>
|
<returns>返回值Hash表</returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DBHelper.ExecuteProductData(System.String,System.Data.SqlClient.SqlParameter[])">
|
<summary>
|
执行存储过程返回返回值
|
</summary>
|
<param name="productName">存储过程名字</param>
|
<param name="parameters">SqlParameter 参数</param>
|
<returns>返回值Hash表</returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DBHelper.ExecuteProductDataList(System.String,System.Data.SqlClient.SqlParameter[])">
|
<summary>
|
执行存储过程返回返回值
|
</summary>
|
<param name="productName">存储过程名字</param>
|
<param name="parameters">SqlParameter 参数</param>
|
<returns>返回值Hash表</returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DBHelper.executeProductList(System.String,System.Boolean,System.Data.SqlClient.SqlParameter[])">
|
<summary>
|
执行存储过程返回返回值
|
</summary>
|
<param name="productName">存储过程名字</param>
|
<param name="parameters">SqlParameter 参数</param>
|
<returns>返回值List</returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DBHelper.ExecuteProductbool(System.String,System.Data.SqlClient.SqlParameter[])">
|
<summary>
|
执行存储过程返回返回值
|
</summary>
|
<param name="productName">存储过程名字</param>
|
<param name="parameters">SqlParameter 参数</param>
|
<returns>返回值DataTable表</returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DBHelper.GetDataByPage(System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.String,System.Int32@)">
|
<summary>
|
分页查询
|
</summary>
|
<param name="filename">表名</param>
|
<param name="filename">需要返回的列</param>
|
<param name="sortfilename">排序字段名</param>
|
<param name="PageSize">页尺寸</param>
|
<param name="PageIndex">页码</param>
|
<param name="OrderType">设置排序类型, 非 0 值则降序</param>
|
<param name="strWhere">查询条件 (注意: 不要加 where)</param>
|
<param name="RecordCount">总记录</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DBHelper.GetDataByPage_V2(System.String,System.String,System.String,System.Int32,System.Int32,System.String,System.Int32@)">
|
<summary>
|
分页查询(支持JOIN)
|
</summary>
|
<param name="filename">表名</param>
|
<param name="filename">需要返回的列</param>
|
<param name="sortfilename">排序字段名(默认升序，降序需在排序字段名后面DESC关键字：sortField Desc)</param>
|
<param name="PageSize">页尺寸</param>
|
<param name="PageIndex">页码</param>
|
<param name="strWhere">查询条件 (注意: 不要加 where)</param>
|
<param name="RecordCount">总记录</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DBHelper.GetDataByPage_V2_Join(System.String,System.String,System.String,System.Int32,System.Int32,System.String,System.Int32@)">
|
<summary>
|
分页查询(支持JOIN)
|
</summary>
|
<param name="filename">表名</param>
|
<param name="filename">需要返回的列</param>
|
<param name="sortfilename">排序字段名(默认升序，降序需在排序字段名后面DESC关键字：sortField Desc)</param>
|
<param name="PageSize">页尺寸</param>
|
<param name="PageIndex">页码</param>
|
<param name="strWhere">查询条件 (注意: 不要加 where)</param>
|
<param name="RecordCount">总记录</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.DBHelper.ParametersStrGet(System.Data.SqlClient.SqlParameter[])">
|
<summary>
|
[用于日志文本输出] 将SqlParameter数组参数转成字符串.
|
</summary>
|
<param name="parameters">参数数组</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.LogHelper.WriteLog(System.Exception)">
|
<summary>
|
输出日志到Log4Net
|
</summary>
|
<param name="ex"></param>
|
</member>
|
<member name="F:VueWebApi.Tools.RedisHelper.RedisIpConnString">
|
<summary>
|
redis获取连接配置字符串
|
</summary>
|
</member>
|
<member name="M:VueWebApi.Tools.RedisHelper.CreateManager(System.String[],System.String[])">
|
<summary>
|
缓冲池
|
</summary>
|
<param name="readWriteHosts"></param>
|
<param name="readOnlyHosts"></param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.RedisHelper.#cctor">
|
<summary>
|
构造函数
|
</summary>
|
<param name="openPooledRedis">是否开启缓冲池</param>
|
</member>
|
<member name="M:VueWebApi.Tools.RedisHelper.Set``1(System.String,``0,System.Int32,System.Int32)">
|
<summary>
|
设置缓存
|
</summary>
|
<typeparam name="T"></typeparam>
|
<param name="key">缓存建</param>
|
<param name="t">缓存值</param>
|
<param name="timeout">过期时间，单位秒,-1：不过期，0：默认过期时间</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.RedisHelper.KeyExpire(System.String,System.Int32)">
|
<summary>
|
设置失效时间
|
</summary>
|
<param name="key"></param>
|
<param name="expiry"></param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.RedisHelper.Get``1(System.String,System.Int32)">
|
<summary>
|
获取
|
</summary>
|
<typeparam name="T"></typeparam>
|
<param name="key"></param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.RedisHelper.Remove(System.String,System.Int32)">
|
<summary>
|
删除
|
</summary>
|
<param name="key"></param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.RedisHelper.AddList``1(System.String,System.Collections.Generic.IEnumerable{``0},System.Int32)">
|
<summary>
|
根据IEnumerable数据添加链表
|
</summary>
|
<typeparam name="T"></typeparam>
|
<param name="listId"></param>
|
<param name="values"></param>
|
<param name="timeout"></param>
|
</member>
|
<member name="M:VueWebApi.Tools.RedisHelper.AddEntityToList``1(System.String,``0,System.Int32,System.Int32)">
|
<summary>
|
添加单个实体到链表中
|
</summary>
|
<typeparam name="T"></typeparam>
|
<param name="listId"></param>
|
<param name="Item"></param>
|
<param name="timeout"></param>
|
</member>
|
<member name="M:VueWebApi.Tools.RedisHelper.GetList``1(System.String,System.Int32)">
|
<summary>
|
获取链表
|
</summary>
|
<typeparam name="T"></typeparam>
|
<param name="listId"></param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Tools.RedisHelper.RemoveEntityFromList``1(System.String,``0,System.Int32)">
|
<summary>
|
在链表中删除单个实体
|
</summary>
|
<typeparam name="T"></typeparam>
|
<param name="listId"></param>
|
<param name="t"></param>
|
</member>
|
<member name="M:VueWebApi.Tools.RedisHelper.RemoveEntityFromList``1(System.String,System.Func{``0,System.Boolean})">
|
<summary>
|
根据lambada表达式删除符合条件的实体
|
</summary>
|
<typeparam name="T"></typeparam>
|
<param name="listId"></param>
|
<param name="func"></param>
|
</member>
|
<member name="M:VueWebApi.Tools.SeachEncode.EncodingSeach(System.String)">
|
<summary>
|
根据功能编码获取最新规则编码
|
</summary>
|
<param name="rightcode">功能编码</param>
|
<returns></returns>
|
</member>
|
<member name="T:VueWebApi.Util.ObjectValueParser`1">
|
<summary>
|
值转换器
|
</summary>
|
<typeparam name="T">指定值的类型</typeparam>
|
<param name="obj">取值来源</param>
|
<returns>返回指定类型的值</returns>
|
</member>
|
<member name="T:VueWebApi.Util.ObjectValueTryParser`1">
|
<summary>
|
尝试将值转换成指定类型 返回转换结果
|
</summary>
|
<typeparam name="T">指定值的类型</typeparam>
|
<param name="obj">取值来源</param>
|
<param name="valueOutput">若转换成功 则out转换结果 否则 out默认T类型值</param>
|
<returns></returns>
|
</member>
|
<member name="T:VueWebApi.Util.StringValueParser`1">
|
<summary>
|
尝试将值转换成指定类型 返回转换结果
|
</summary>
|
<typeparam name="T">指定值的类型</typeparam>
|
<param name="str">取值来源字符串</param>
|
<returns>返回指定类型的值</returns>
|
</member>
|
<member name="T:VueWebApi.Util.StringValueTryParser`1">
|
<summary>
|
尝试将值转换成指定类型 返回转换成功与否
|
</summary>
|
<typeparam name="T">指定值的类型</typeparam>
|
<param name="str">取值来源字符串</param>
|
<param name="valueOutput">若转换成功 则out转换结果 否则 out默认T类型值</param>
|
<returns></returns>
|
</member>
|
<member name="T:VueWebApi.Util.EntityHelper">
|
<summary>
|
实体帮助类
|
</summary>
|
</member>
|
<member name="M:VueWebApi.Util.EntityHelper.GetObject(System.Data.DataRow,System.String)">
|
<summary>
|
从一行数据中尝试获取指定列名的值
|
</summary>
|
<param name="dr">源数据行</param>
|
<param name="columnName">指定列名</param>
|
<returns>若指定的列名存在并有效则返回取到的对象，若指定列名不存在或者为无效数据则返回null</returns>
|
</member>
|
<member name="M:VueWebApi.Util.EntityHelper.GetT``1(System.Data.DataRow,System.String,``0,VueWebApi.Util.ObjectValueParser{``0})">
|
<summary>
|
从一行数据中尝试获取指定引用类型的值
|
</summary>
|
<typeparam name="T">指定类型的值</typeparam>
|
<param name="dr">源数据行</param>
|
<param name="columnName">列名</param>
|
<param name="defVal">列无效时返回的默认值</param>
|
<param name="parser">值转换器 若给定的值转换器为null，则使用as强制转换，若as转换为null 则返回默认值</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Util.EntityHelper.Get``1(System.Object,``0,VueWebApi.Util.ObjectValueParser{``0})">
|
<summary>
|
将对象转换为指定类型数据 转换失败返回设置的默认值
|
</summary>
|
<typeparam name="T">指定的类型</typeparam>
|
<param name="source">数据源</param>
|
<param name="defVal">列无效时返回的默认值</param>
|
<param name="parser">值转换器 若给定的值转换器为null，则使用as强制转换，若as转换为null 则返回默认值</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Util.EntityHelper.TryGetT``1(System.Data.DataRow,System.String,``0,VueWebApi.Util.ObjectValueTryParser{``0})">
|
<summary>
|
从一行数据中尝试获取指定引用类型的值
|
</summary>
|
<typeparam name="T">指定的类型</typeparam>
|
<param name="dr">源数据行</param>
|
<param name="columnName">列名</param>
|
<param name="defVal">列无效时返回的默认值</param>
|
<param name="parser">值转换器 若给定的值转换器为null，则使用as强制转换，若as转换为null 则返回默认值</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Util.EntityHelper.TryGetT``1(System.Object,``0,VueWebApi.Util.ObjectValueTryParser{``0})">
|
<summary>
|
将对象尝试转换为指定类型的数据 转换失败返回指定的默认值
|
</summary>
|
<typeparam name="T">指定的类型</typeparam>
|
<param name="source">数据源</param>
|
<param name="defVal">默认值</param>
|
<param name="parser">值转换器 若给定的值转换器为null，则使用as强制转换，若as转换为null 则返回默认值</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Util.EntityHelper.GetT``1(System.Data.DataRow,System.String,``0,VueWebApi.Util.StringValueParser{``0})">
|
<summary>
|
从一行数据中尝试获取指定值类型的值
|
</summary>
|
<typeparam name="T">指定类型的值</typeparam>
|
<param name="dr">源数据行</param>
|
<param name="columnName">列名</param>
|
<param name="defVal">列无效时返回的默认值</param>
|
<param name="parser">值转换器</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Util.EntityHelper.GetT``1(System.Object,``0,VueWebApi.Util.StringValueParser{``0})">
|
<summary>
|
将对象转换为指定类型数据 转换失败返回设置的默认值
|
</summary>
|
<typeparam name="T">指定的类型</typeparam>
|
<param name="source">数据源</param>
|
<param name="defVal">列无效时返回的默认值</param>
|
<param name="parser">值转换器</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Util.EntityHelper.TryGetT``1(System.Data.DataRow,System.String,``0,VueWebApi.Util.StringValueTryParser{``0})">
|
<summary>
|
从一行数据中尝试获取指定值类型的值
|
</summary>
|
<typeparam name="T">指定类型的值</typeparam>
|
<param name="dr">源数据行</param>
|
<param name="columnName">列名</param>
|
<param name="defVal">列无效时返回的默认值</param>
|
<param name="parser">值转换器</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Util.EntityHelper.TryGetT``1(System.Object,``0,VueWebApi.Util.StringValueTryParser{``0})">
|
<summary>
|
将对象尝试转换为指定类型的数据 转换失败返回指定的默认值
|
</summary>
|
<typeparam name="T">指定的类型</typeparam>
|
<param name="obj">数据源</param>
|
<param name="defVal">默认值</param>
|
<param name="parser">值转换器</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Util.EntityHelper.GetString(System.Data.DataRow,System.String,System.String)">
|
<summary>
|
从一行数据中尝试获取字符串
|
</summary>
|
<param name="dr">源数据行</param>
|
<param name="columnName">列名</param>
|
<param name="defVal">列无效时返回的默认值</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Util.EntityHelper.GetString(System.Object,System.String)">
|
<summary>
|
获取字符串 检测 数据源为空时返回默认值
|
</summary>
|
<param name="source">数据源</param>
|
<param name="defVal">默认值</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Util.EntityHelper.GetInt(System.Data.DataRow,System.String,System.Int32)">
|
<summary>
|
从一行数据中尝试获取整数
|
</summary>
|
<param name="dr">源数据行</param>
|
<param name="columnName">列名</param>
|
<param name="defVal">列无效时返回的默认值</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Util.EntityHelper.GetInt(System.Object,System.Int32)">
|
<summary>
|
从数据员获取整数
|
</summary>
|
<param name="source">数据源</param>
|
<param name="defVal">获取失败时的默认值</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Util.EntityHelper.GetDateTime(System.Data.DataRow,System.String,System.DateTime)">
|
<summary>
|
从一行数据中尝试获取日期
|
</summary>
|
<param name="dr">源数据行</param>
|
<param name="columnName">列名</param>
|
<param name="defVal">列无效时返回的默认值</param>
|
<returns></returns>
|
</member>
|
<member name="M:VueWebApi.Util.EntityHelper.GetDateTime(System.Object,System.DateTime)">
|
<summary>
|
从数据源中 获取日期
|
</summary>
|
<param name="source">数据源</param>
|
<param name="defVal">获取失败时的默认值</param>
|
<returns></returns>
|
</member>
|
<member name="T:ControllerGroupAttribute">
|
<summary>
|
Controller描述信息
|
</summary>
|
</member>
|
<member name="P:ControllerGroupAttribute.GroupName">
|
<summary>
|
当前Controller所属模块 请用中文
|
</summary>
|
</member>
|
<member name="P:ControllerGroupAttribute.Useage">
|
<summary>
|
当前controller用途 请用中文
|
</summary>
|
</member>
|
<member name="M:ControllerGroupAttribute.#ctor(System.String,System.String)">
|
<summary>
|
Controller描述信息 构造
|
</summary>
|
<param name="groupName">模块名称</param>
|
<param name="useage">当前controller用途</param>
|
</member>
|
<member name="T:HiddenApiAttribute">
|
<summary>
|
隐藏接口，不生成到swagger文档展示
|
</summary>
|
<seealso cref="T:System.Attribute" />
|
</member>
|
<member name="T:HiddenApiFilter">
|
<summary>
|
Class HiddenApiFilter.
|
</summary>
|
<seealso cref="T:Swashbuckle.Swagger.IDocumentFilter" />
|
</member>
|
<member name="M:HiddenApiFilter.Apply(Swashbuckle.Swagger.SwaggerDocument,Swashbuckle.Swagger.SchemaRegistry,System.Web.Http.Description.IApiExplorer)">
|
<summary>
|
重写Apply方法，移除隐藏接口的生成
|
</summary>
|
<param name="swaggerDoc">swagger文档文件</param>
|
<param name="schemaRegistry"></param>
|
<param name="apiExplorer">api接口集合</param>
|
</member>
|
<member name="T:HttpAuthHeaderFilter">
|
<summary>
|
swagger 增加 AUTH 选项
|
</summary>
|
</member>
|
<member name="M:HttpAuthHeaderFilter.Apply(Swashbuckle.Swagger.Operation,Swashbuckle.Swagger.SchemaRegistry,System.Web.Http.Description.ApiDescription)">
|
<summary>
|
应用
|
</summary>
|
<param name="operation"></param>
|
<param name="schemaRegistry"></param>
|
<param name="apiDescription"></param>
|
</member>
|
<member name="T:SwaggerControllerDescProvider">
|
<summary>
|
swagger显示控制器的描述
|
</summary>
|
</member>
|
<member name="M:SwaggerControllerDescProvider.#ctor(Swashbuckle.Swagger.ISwaggerProvider,System.String)">
|
<summary>
|
|
</summary>
|
<param name="swaggerProvider"></param>
|
<param name="xml">xml文档路径</param>
|
</member>
|
<member name="M:SwaggerControllerDescProvider.GetSwagger(System.String,System.String)">
|
<summary>
|
Gets the swagger.
|
</summary>
|
<param name="rootUrl">The root URL.</param>
|
<param name="apiVersion">The API version.</param>
|
<returns>SwaggerDocument.</returns>
|
</member>
|
<member name="M:SwaggerControllerDescProvider.GetControllerDesc">
|
<summary>
|
从API文档中读取控制器描述
|
</summary>
|
<returns>所有控制器描述</returns>
|
</member>
|
</members>
|
</doc>
|
