123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>ZX.Api</name>
- </assembly>
- <members>
- <member name="T:ZX.Api.App_Start.Filter.ActionFilter">
- <summary>
- 自定义拦截器
- </summary>
- </member>
- <member name="M:ZX.Api.App_Start.Filter.ActionFilter.OnActionExecuting(System.Web.Http.Controllers.HttpActionContext)">
- <summary>
- 拦截器
- </summary>
- </member>
- <member name="M:ZX.Api.App_Start.Filter.ActionFilter.OnActionExecuted(System.Web.Http.Filters.HttpActionExecutedContext)">
- <summary>
- 输出拦截器
- </summary>
- <param name="actionExecutedContext"></param>
- </member>
- <member name="M:ZX.Api.App_Start.Filter.ActionFilter.Compress(System.Byte[])">
- <summary>
- GZip压缩
- </summary>
- <param name="rawData"></param>
- <returns></returns>
- </member>
- <member name="T:ZX.Api.App_Start.Filter.TokenHelper">
- <summary>
- 验证帮助类
- </summary>
- </member>
- <member name="M:ZX.Api.App_Start.Filter.TokenHelper.DesDecrypt(System.String)">
- 解密
- </member>
- <member name="M:ZX.Api.App_Start.Filter.TokenHelper.HexStringToByteArray(System.String)">
- <summary>
- 将指定的16进制字符串转换为byte数组
- </summary>
- <param name="s">16进制字符串(如:“7F 2C 4A”或“7F2C4A”都可以)</param>
- <returns>16进制字符串对应的byte数组</returns>
- </member>
- <!-- 对于成员“M:ZX.Api.App_Start.Filter.TokenHelper.ConvertStringToDateTime(System.String)”忽略有格式错误的 XML 注释 -->
- <member name="M:ZX.Api.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:ZX.Api.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:ZX.Api.Areas.HelpPage.Controllers.HelpController">
- <summary>
- The controller that will handle requests for the help page.
- </summary>
- </member>
- <member name="M:ZX.Api.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:ZX.Api.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:ZX.Api.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:ZX.Api.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:ZX.Api.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:ZX.Api.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:ZX.Api.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:ZX.Api.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:ZX.Api.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:ZX.Api.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:ZX.Api.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:ZX.Api.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:ZX.Api.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:ZX.Api.Areas.HelpPage.HelpPageConfigurationExtensions.SetHelpPageSampleGenerator(System.Web.Http.HttpConfiguration,ZX.Api.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:ZX.Api.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:ZX.Api.Areas.HelpPage.ModelDescriptions.ModelDescriptionGenerator"/>
- </returns>
- </member>
- <member name="M:ZX.Api.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:ZX.Api.Areas.HelpPage.Models.HelpPageApiModel"/>
- </returns>
- </member>
- <member name="T:ZX.Api.Areas.HelpPage.ModelDescriptions.ModelDescription">
- <summary>
- Describes a type model.
- </summary>
- </member>
- <member name="T:ZX.Api.Areas.HelpPage.ModelDescriptions.ModelDescriptionGenerator">
- <summary>
- Generates model descriptions for given types.
- </summary>
- </member>
- <member name="T:ZX.Api.Areas.HelpPage.ModelDescriptions.ModelNameAttribute">
- <summary>
- Use this attribute to change the name of the <see cref="T:ZX.Api.Areas.HelpPage.ModelDescriptions.ModelDescription"/> generated for a type.
- </summary>
- </member>
- <member name="T:ZX.Api.Areas.HelpPage.Models.HelpPageApiModel">
- <summary>
- The model that represents an API displayed on the help page.
- </summary>
- </member>
- <member name="M:ZX.Api.Areas.HelpPage.Models.HelpPageApiModel.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:ZX.Api.Areas.HelpPage.Models.HelpPageApiModel"/> class.
- </summary>
- </member>
- <member name="P:ZX.Api.Areas.HelpPage.Models.HelpPageApiModel.ApiDescription">
- <summary>
- Gets or sets the <see cref="P:ZX.Api.Areas.HelpPage.Models.HelpPageApiModel.ApiDescription"/> that describes the API.
- </summary>
- </member>
- <member name="P:ZX.Api.Areas.HelpPage.Models.HelpPageApiModel.UriParameters">
- <summary>
- Gets or sets the <see cref="T:ZX.Api.Areas.HelpPage.ModelDescriptions.ParameterDescription"/> collection that describes the URI parameters for the API.
- </summary>
- </member>
- <member name="P:ZX.Api.Areas.HelpPage.Models.HelpPageApiModel.RequestDocumentation">
- <summary>
- Gets or sets the documentation for the request.
- </summary>
- </member>
- <member name="P:ZX.Api.Areas.HelpPage.Models.HelpPageApiModel.RequestModelDescription">
- <summary>
- Gets or sets the <see cref="T:ZX.Api.Areas.HelpPage.ModelDescriptions.ModelDescription"/> that describes the request body.
- </summary>
- </member>
- <member name="P:ZX.Api.Areas.HelpPage.Models.HelpPageApiModel.RequestBodyParameters">
- <summary>
- Gets the request body parameter descriptions.
- </summary>
- </member>
- <member name="P:ZX.Api.Areas.HelpPage.Models.HelpPageApiModel.ResourceDescription">
- <summary>
- Gets or sets the <see cref="T:ZX.Api.Areas.HelpPage.ModelDescriptions.ModelDescription"/> that describes the resource.
- </summary>
- </member>
- <member name="P:ZX.Api.Areas.HelpPage.Models.HelpPageApiModel.ResourceProperties">
- <summary>
- Gets the resource property descriptions.
- </summary>
- </member>
- <member name="P:ZX.Api.Areas.HelpPage.Models.HelpPageApiModel.SampleRequests">
- <summary>
- Gets the sample requests associated with the API.
- </summary>
- </member>
- <member name="P:ZX.Api.Areas.HelpPage.Models.HelpPageApiModel.SampleResponses">
- <summary>
- Gets the sample responses associated with the API.
- </summary>
- </member>
- <member name="P:ZX.Api.Areas.HelpPage.Models.HelpPageApiModel.ErrorMessages">
- <summary>
- Gets the error messages associated with this model.
- </summary>
- </member>
- <member name="T:ZX.Api.Areas.HelpPage.HelpPageSampleGenerator">
- <summary>
- This class will generate the samples for the help page.
- </summary>
- </member>
- <member name="M:ZX.Api.Areas.HelpPage.HelpPageSampleGenerator.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:ZX.Api.Areas.HelpPage.HelpPageSampleGenerator"/> class.
- </summary>
- </member>
- <member name="P:ZX.Api.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:ZX.Api.Areas.HelpPage.HelpPageSampleGenerator.ActionSamples">
- <summary>
- Gets the objects that are used directly as samples for certain actions.
- </summary>
- </member>
- <member name="P:ZX.Api.Areas.HelpPage.HelpPageSampleGenerator.SampleObjects">
- <summary>
- Gets the objects that are serialized as samples by the supported formatters.
- </summary>
- </member>
- <member name="P:ZX.Api.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:ZX.Api.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:ZX.Api.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:ZX.Api.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:ZX.Api.Areas.HelpPage.HelpPageSampleGenerator.GetSample(System.Web.Http.Description.ApiDescription,ZX.Api.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:ZX.Api.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,ZX.Api.Areas.HelpPage.SampleDirection)">
- <summary>
- Search for samples that are provided directly through <see cref="P:ZX.Api.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:ZX.Api.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:ZX.Api.Areas.HelpPage.HelpPageSampleGenerator.SampleObjects"/>. If no sample object is found, it will try to create
- one using <see cref="M:ZX.Api.Areas.HelpPage.HelpPageSampleGenerator.DefaultSampleObjectFactory(ZX.Api.Areas.HelpPage.HelpPageSampleGenerator,System.Type)"/> (which wraps an <see cref="T:ZX.Api.Areas.HelpPage.ObjectGenerator"/>) and other
- factories in <see cref="P:ZX.Api.Areas.HelpPage.HelpPageSampleGenerator.SampleObjectFactories"/>.
- </summary>
- <param name="type">The type.</param>
- <returns>The sample object.</returns>
- </member>
- <member name="M:ZX.Api.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:ZX.Api.Areas.HelpPage.HelpPageSampleGenerator.ResolveType(System.Web.Http.Description.ApiDescription,System.String,System.String,System.Collections.Generic.IEnumerable{System.String},ZX.Api.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:ZX.Api.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:ZX.Api.Areas.HelpPage.HelpPageSampleKey">
- <summary>
- This is used to identify the place where the sample should be applied.
- </summary>
- </member>
- <member name="M:ZX.Api.Areas.HelpPage.HelpPageSampleKey.#ctor(System.Net.Http.Headers.MediaTypeHeaderValue)">
- <summary>
- Creates a new <see cref="T:ZX.Api.Areas.HelpPage.HelpPageSampleKey"/> based on media type.
- </summary>
- <param name="mediaType">The media type.</param>
- </member>
- <member name="M:ZX.Api.Areas.HelpPage.HelpPageSampleKey.#ctor(System.Net.Http.Headers.MediaTypeHeaderValue,System.Type)">
- <summary>
- Creates a new <see cref="T:ZX.Api.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:ZX.Api.Areas.HelpPage.HelpPageSampleKey.#ctor(ZX.Api.Areas.HelpPage.SampleDirection,System.String,System.String,System.Collections.Generic.IEnumerable{System.String})">
- <summary>
- Creates a new <see cref="T:ZX.Api.Areas.HelpPage.HelpPageSampleKey"/> based on <see cref="P:ZX.Api.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>, controller name, action name and parameter names.
- </summary>
- <param name="sampleDirection">
- The <see cref="P:ZX.Api.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:ZX.Api.Areas.HelpPage.HelpPageSampleKey.#ctor(System.Net.Http.Headers.MediaTypeHeaderValue,ZX.Api.Areas.HelpPage.SampleDirection,System.String,System.String,System.Collections.Generic.IEnumerable{System.String})">
- <summary>
- Creates a new <see cref="T:ZX.Api.Areas.HelpPage.HelpPageSampleKey"/> based on media type, <see cref="P:ZX.Api.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:ZX.Api.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:ZX.Api.Areas.HelpPage.HelpPageSampleKey.ControllerName">
- <summary>
- Gets the name of the controller.
- </summary>
- <value>
- The name of the controller.
- </value>
- </member>
- <member name="P:ZX.Api.Areas.HelpPage.HelpPageSampleKey.ActionName">
- <summary>
- Gets the name of the action.
- </summary>
- <value>
- The name of the action.
- </value>
- </member>
- <member name="P:ZX.Api.Areas.HelpPage.HelpPageSampleKey.MediaType">
- <summary>
- Gets the media type.
- </summary>
- <value>
- The media type.
- </value>
- </member>
- <member name="P:ZX.Api.Areas.HelpPage.HelpPageSampleKey.ParameterNames">
- <summary>
- Gets the parameter names.
- </summary>
- </member>
- <member name="P:ZX.Api.Areas.HelpPage.HelpPageSampleKey.SampleDirection">
- <summary>
- Gets the <see cref="P:ZX.Api.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>.
- </summary>
- </member>
- <member name="T:ZX.Api.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:ZX.Api.Areas.HelpPage.ImageSample.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:ZX.Api.Areas.HelpPage.ImageSample"/> class.
- </summary>
- <param name="src">The URL of an image.</param>
- </member>
- <member name="T:ZX.Api.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:ZX.Api.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:ZX.Api.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:ZX.Api.Areas.HelpPage.SampleDirection">
- <summary>
- Indicates whether the sample is used for request or response
- </summary>
- </member>
- <member name="T:ZX.Api.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:ZX.Api.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:ZX.Api.Areas.HelpPage.XmlDocumentationProvider.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:ZX.Api.Areas.HelpPage.XmlDocumentationProvider"/> class.
- </summary>
- <param name="documentPath">The physical path to XML document.</param>
- </member>
- <member name="T:ZX.Api.Controllers.NewManagerController">
- <summary>
- 资讯新闻管理
- </summary>
- </member>
- <member name="M:ZX.Api.Controllers.NewManagerController.GetAnnouncement">
- <summary>
- 得到公告
- </summary>
- </member>
- <member name="M:ZX.Api.Controllers.NewManagerController.GetNews(System.Int32)">
- <summary>
- 得到彩市新闻
- </summary>
- <param name="topNumber">条数</param>
- <returns></returns>
- </member>
- <member name="M:ZX.Api.Controllers.NewManagerController.GetNewManagerList(ZX.Model.Query.GetNewManagerListQuery)">
- <summary>
- 根据新闻类型获取对应条数的数据
- </summary>
- <param name="query">条件</param>
- <returns></returns>
- </member>
- <member name="M:ZX.Api.Controllers.NewManagerController.GetNewManagerPageList(ZX.Model.Query.GetNewManagerPageListQuery)">
- <summary>
- 根据新闻类型获取对应条数的数据(分页)
- </summary>
- <param name="query">条件</param>
- <returns></returns>
- </member>
- <member name="M:ZX.Api.Controllers.NewManagerController.GetNewsById(System.Int32)">
- <summary>
- 得到新闻详情(ID)
- </summary>
- <param name="Id">新闻id</param>
- <returns></returns>
- </member>
- <member name="M:ZX.Api.Controllers.NewManagerController.LatestHotList(ZX.Model.Query.LatestHotQuery)">
- <summary>
- 获取最新热门资讯
- </summary>
- <param name="query">条件</param>
- <returns></returns>
- </member>
- <member name="M:ZX.Api.Controllers.NewManagerController.GetMenuList(System.Int32)">
- <summary>
- 获得菜单、和相关的任务(3d,预测等)(包含TDK)
- </summary>
- <param name="topNumber">LabelModels人物标签的数目</param>
- <returns></returns>
- </member>
- <member name="M:ZX.Api.Controllers.NewManagerController.GetLablesModelsList(System.Int32,ZX.Model.Enum.LatestHotTypeEnum)">
- <summary>
- 获取人物
- </summary>
- <param name="topNumber">LabelModels人物标签的数目</param>
- <param name="latestHotType">类型</param>
- <returns></returns>
- </member>
- <member name="M:ZX.Api.Controllers.NewManagerController.GetPageList(ZX.Api.Models.TK.Query.GetPageListQuery)">
- <summary>
- 根据新闻类型\lableId获取对应条数的数据(分页)(包含TDK)
- </summary>
- <param name="query">条件</param>
- <returns></returns>
- </member>
- <member name="M:ZX.Api.Controllers.NewManagerController.GetList(ZX.Model.Query.GetNewManagerListQuery)">
- <summary>
- 根据类型获取相应数目的数据(包含TDK)
- </summary>
- <param name="query">条件</param>
- <returns></returns>
- </member>
- <member name="M:ZX.Api.Controllers.NewManagerController.GetTDK(ZX.Api.Models.ZX.DTO.TDKQuery)">
- <summary>
- 得到新闻详情(ID)
- </summary>
- <param name="query">条件</param>
- <returns></returns>
- </member>
- <member name="M:ZX.Api.Controllers.NewManagerController.GetLatestNewManagerList(System.Int32)">
- <summary>
- 所有资讯最新数据
- </summary>
- <param name="top">条数</param>
- <returns></returns>
- </member>
- <member name="M:ZX.Api.Controllers.NewManagerController.GetImgList(ZX.Model.Enum.ViewTypeEnum)">
- <summary>
- 根据类型获取图片路径
- </summary>
- <param name="viewType">类型</param>
- <returns></returns>
- </member>
- <member name="T:ZX.Api.Controllers.GalleryManagerController">
- <summary>
- 图库信息管理
- </summary>
- </member>
- <member name="F:ZX.Api.Controllers.GalleryManagerController.galleryList">
- <summary>
- 得到菜单数据
- </summary>
- </member>
- <member name="F:ZX.Api.Controllers.GalleryManagerController.galleryHbLsit">
- <summary>
- 得到菜单的合并数据
- </summary>
- </member>
- <member name="F:ZX.Api.Controllers.GalleryManagerController.kjhGalleryList">
- <summary>
- 得到开奖号菜单数据
- </summary>
- </member>
- <member name="F:ZX.Api.Controllers.GalleryManagerController.kjhGalleryHbLsit">
- <summary>
- 得到开奖号菜单的合并数据
- </summary>
- </member>
- <member name="F:ZX.Api.Controllers.GalleryManagerController.menuManagerList">
- <summary>
- 获得MenuManager的数据
- </summary>
- </member>
- <member name="P:ZX.Api.Controllers.GalleryManagerController.GalleryList">
- <summary>
- GalleryManager的所有数据
- </summary>
- </member>
- <member name="P:ZX.Api.Controllers.GalleryManagerController.GalleryHbLsit">
- <summary>
- 得到菜单的合并数据
- </summary>
- </member>
- <member name="P:ZX.Api.Controllers.GalleryManagerController.MenuManagerList">
- <summary>
- 获得MenuManager的数据
- </summary>
- </member>
- <member name="P:ZX.Api.Controllers.GalleryManagerController.KjhGalleryList">
- <summary>
- 得到开奖号菜单数据
- </summary>
- </member>
- <member name="P:ZX.Api.Controllers.GalleryManagerController.KjhGalleryHbLsit">
- <summary>
- 得到开奖号菜单的合并数据
- </summary>
- </member>
- <member name="M:ZX.Api.Controllers.GalleryManagerController.GetGalleryList(System.Nullable{System.Int32},System.Boolean)">
- <summary>
- 获取最新图库的数据和根据传入期数获取相应期数数据
- </summary>
- <param name="qi">期数</param>
- <param name="isNew">是否为最新</param>
- <returns></returns>
- </member>
- <member name="M:ZX.Api.Controllers.GalleryManagerController.GetKjhGalleryList(System.String,System.Int32,System.Boolean)">
- <summary>
- 获取最新图库的数据和根据传入期数获取相应期数数据(kjh)
- </summary>
- <param name="number">期数</param>
- <param name="year">年数</param>
- <param name="isNew">是否是最新</param>
- <returns></returns>
- </member>
- <member name="M:ZX.Api.Controllers.GalleryManagerController.GetHotGalleryList(System.Nullable{System.Int32})">
- <summary>
- 获取热门图库
- </summary>
- <param name="qi"></param>
- <returns></returns>
- </member>
- <member name="M:ZX.Api.Controllers.GalleryManagerController.GetQi(System.String)">
- <summary>
- 期数补0
- </summary>
- <param name="qi"></param>
- <returns></returns>
- </member>
- <member name="M:ZX.Api.Controllers.GalleryManagerController.GetKjhHotGalleryList(System.String,System.Int32,System.Collections.Generic.List{System.String})">
- <summary>
- 获取热门图库(kjh)
- </summary>
- <param name="number">期数</param>
- <param name="year">年数</param>
- <param name="menuNameList">菜单数据(图库的)</param>
- <returns></returns>
- </member>
- <member name="M:ZX.Api.Controllers.GalleryManagerController.GetHistoryGalleryList">
- <summary>
- 获取历史图库
- </summary>
- <returns></returns>
- </member>
- <member name="M:ZX.Api.Controllers.GalleryManagerController.GetGalleryDetails(System.Int32)">
- <summary>
- 根据imgId获取图库的详情
- </summary>
- <param name="imgId"></param>
- <returns></returns>
- </member>
- <member name="T:ZX.Api.Controllers.OtherController">
- <summary>
- 其他管理
- </summary>
- </member>
- <member name="M:ZX.Api.Controllers.OtherController.GetZtkjModel(System.String)">
- <summary>
- 获取专题数据(m.55128漆詹专用,其他勿用)
- </summary>
- <param name="code"></param>
- <returns></returns>
- </member>
- <member name="T:ZX.Api.Controllers.TokenController">
- <summary>
- Token管理
- </summary>
- </member>
- <member name="M:ZX.Api.Controllers.TokenController.GetToken">
- <summary>
- 获取Token
- </summary>
- <returns></returns>
- </member>
- <member name="M:ZX.Api.WebApiApplication.Application_BeginRequest(System.Object,System.EventArgs)">
- <summary>
- 跨域配置
- </summary>
- <param name="sender"></param>
- <param name="e"></param>
- </member>
- <member name="P:ZX.Api.Models.Other.ZtkjModel.Code">
- <summary>
- 编码
- </summary>
- </member>
- <member name="P:ZX.Api.Models.Other.ZtkjModel.Name">
- <summary>
- 名称
- </summary>
- </member>
- <member name="P:ZX.Api.Models.Other.ZtkjModel.Content">
- <summary>
- 内容
- </summary>
- </member>
- <member name="P:ZX.Api.Models.Other.ZtkjModel.TitleElement">
- <summary>
- D
- </summary>
- </member>
- <member name="P:ZX.Api.Models.Other.ZtkjModel.DescriptionElement">
- <summary>
- D
- </summary>
- </member>
- <member name="P:ZX.Api.Models.Other.ZtkjModel.KeywordElement">
- <summary>
- K
- </summary>
- </member>
- <member name="T:ZX.Api.Models.TK.GalleryManagerModelsDTO">
- <summary>
- 返回数据集合
- </summary>
- </member>
- <member name="T:ZX.Api.Models.TK.GalleryDTO">
- <summary>
- 菜单数据
- </summary>
- </member>
- <member name="P:ZX.Api.Models.TK.GalleryDTO.MenuName">
- <summary>
- 菜单名(A、B、C)
- </summary>
- </member>
- <member name="P:ZX.Api.Models.TK.GalleryDTO.ImgLsit">
- <summary>
- 图片数据
- </summary>
- </member>
- <member name="T:ZX.Api.Models.TK.ImgModel">
- <summary>
- 图片实体
- </summary>
- </member>
- <member name="P:ZX.Api.Models.TK.ImgModel.Title">
- <summary>
- 标题
- </summary>
- </member>
- <member name="P:ZX.Api.Models.TK.ImgModel.ImgId">
- <summary>
- 图片Id
- </summary>
- </member>
- <member name="P:ZX.Api.Models.TK.ImgModel.Number">
- <summary>
- 编码
- </summary>
- </member>
- <member name="P:ZX.Api.Models.TK.ImgModel.MenuName">
- <summary>
- 菜单名(A、B、C)
- </summary>
- </member>
- <member name="P:ZX.Api.Models.TK.HistoryGalleryDTO.Year">
- <summary>
- 年份
- </summary>
- </member>
- <member name="P:ZX.Api.Models.TK.HistoryGalleryDTO.ImgLsit">
- <summary>
- 图片数据
- </summary>
- </member>
- <member name="P:ZX.Api.Models.TK.ImgYearModel.Title">
- <summary>
- 标题
- </summary>
- </member>
- <member name="P:ZX.Api.Models.TK.Query.GetPageListQuery.NewManagerType">
- <summary>
- 类型集合
- </summary>
- </member>
- <member name="P:ZX.Api.Models.TK.Query.GetPageListQuery.LabelId">
- <summary>
- labelID和NewManagerType不能并存
- </summary>
- </member>
- <member name="P:ZX.Api.Models.ZX.DTO.TDKQuery.IdList">
- <summary>
- Id集合
- </summary>
- </member>
- <member name="P:ZX.Api.Models.ZX.DTO.TDKQuery.TDKEnum">
- <summary>
- 类型
- </summary>
- </member>
- <member name="P:ZX.Api.Models.ZX.GetPageListDTO.TitleElement">
- <summary>
- D
- </summary>
- </member>
- <member name="P:ZX.Api.Models.ZX.GetPageListDTO.DescriptionElement">
- <summary>
- D
- </summary>
- </member>
- <member name="P:ZX.Api.Models.ZX.GetPageListDTO.KeywordElement">
- <summary>
- K
- </summary>
- </member>
- <member name="P:ZX.Api.Models.ZX.GetPageListDTO.LabelName">
- <summary>
- label名称
- </summary>
- </member>
- <member name="P:ZX.Api.Models.ZX.GetPageListDTO.Shorthand">
- <summary>
- 编码
- </summary>
- </member>
- <member name="P:ZX.Api.Models.ZX.GetListDTO.TitleElement">
- <summary>
- D
- </summary>
- </member>
- <member name="P:ZX.Api.Models.ZX.GetListDTO.DescriptionElement">
- <summary>
- D
- </summary>
- </member>
- <member name="P:ZX.Api.Models.ZX.GetListDTO.KeywordElement">
- <summary>
- K
- </summary>
- </member>
- <member name="P:ZX.Api.Models.ZX.GetListDTO.LabelName">
- <summary>
- label名称
- </summary>
- </member>
- <member name="P:ZX.Api.Models.ZX.LabelModelsDTO.Id">
- <summary>
- 编码
- </summary>
- </member>
- <member name="P:ZX.Api.Models.ZX.LabelModelsDTO.Name">
- <summary>
- 名称
- </summary>
- </member>
- <member name="T:ZX.API.Areas.HelpPage.MultiXmlDocumentationProvider">
- <summary>
- A custom <see cref="T:System.Web.Http.Description.IDocumentationProvider"/> that reads the API documentation from a collection of XML documentation files.
- </summary>
- </member>
- <member name="F:ZX.API.Areas.HelpPage.MultiXmlDocumentationProvider.Providers">
- <summary>The internal documentation providers for specific files.</summary>
- </member>
- <member name="M:ZX.API.Areas.HelpPage.MultiXmlDocumentationProvider.#ctor(System.String[])">
- <summary>Construct an instance.</summary>
- <param name="paths">The physical paths to the XML documents.</param>
- </member>
- <member name="M:ZX.API.Areas.HelpPage.MultiXmlDocumentationProvider.GetDocumentation(System.Reflection.MemberInfo)">
- <summary>Gets the documentation for a subject.</summary>
- <param name="subject">The subject to document.</param>
- </member>
- <member name="M:ZX.API.Areas.HelpPage.MultiXmlDocumentationProvider.GetDocumentation(System.Type)">
- <summary>Gets the documentation for a subject.</summary>
- <param name="subject">The subject to document.</param>
- </member>
- <member name="M:ZX.API.Areas.HelpPage.MultiXmlDocumentationProvider.GetDocumentation(System.Web.Http.Controllers.HttpControllerDescriptor)">
- <summary>Gets the documentation for a subject.</summary>
- <param name="subject">The subject to document.</param>
- </member>
- <member name="M:ZX.API.Areas.HelpPage.MultiXmlDocumentationProvider.GetDocumentation(System.Web.Http.Controllers.HttpActionDescriptor)">
- <summary>Gets the documentation for a subject.</summary>
- <param name="subject">The subject to document.</param>
- </member>
- <member name="M:ZX.API.Areas.HelpPage.MultiXmlDocumentationProvider.GetDocumentation(System.Web.Http.Controllers.HttpParameterDescriptor)">
- <summary>Gets the documentation for a subject.</summary>
- <param name="subject">The subject to document.</param>
- </member>
- <member name="M:ZX.API.Areas.HelpPage.MultiXmlDocumentationProvider.GetResponseDocumentation(System.Web.Http.Controllers.HttpActionDescriptor)">
- <summary>Gets the documentation for a subject.</summary>
- <param name="subject">The subject to document.</param>
- </member>
- <member name="M:ZX.API.Areas.HelpPage.MultiXmlDocumentationProvider.GetFirstMatch(System.Func{ZX.Api.Areas.HelpPage.XmlDocumentationProvider,System.String})">
- <summary>Get the first valid result from the collection of XML documentation providers.</summary>
- <param name="expr">The method to invoke.</param>
- </member>
- </members>
- </doc>
|