CP.Api.xml 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>CP.Api</name>
  5. </assembly>
  6. <members>
  7. <member name="M:CP.Api.CustomExceptionFilterAttribute.OnException(System.Web.Http.Filters.HttpActionExecutedContext)">
  8. <summary>
  9. 异常处理
  10. </summary>
  11. <param name="context"></param>
  12. </member>
  13. <member name="M:CP.Api.ActionFilter.OnActionExecuting(System.Web.Http.Controllers.HttpActionContext)">
  14. <summary>
  15. 拦截器
  16. </summary>
  17. </member>
  18. <member name="M:CP.Api.ActionFilter.OnActionExecuted(System.Web.Http.Filters.HttpActionExecutedContext)">
  19. <summary>
  20. 输出拦截器
  21. </summary>
  22. <param name="actionExecutedContext"></param>
  23. </member>
  24. <member name="M:CP.Api.Areas.HelpPage.ApiDescriptionExtensions.GetFriendlyId(System.Web.Http.Description.ApiDescription)">
  25. <summary>
  26. 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}"
  27. </summary>
  28. <param name="description">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
  29. <returns>The ID as a string.</returns>
  30. </member>
  31. <member name="T:CP.Api.Areas.HelpPage.HelpPageConfig">
  32. <summary>
  33. Use this class to customize the Help Page.
  34. For example you can set a custom <see cref="T:System.Web.Http.Description.IDocumentationProvider"/> to supply the documentation
  35. or you can provide the samples for the requests/responses.
  36. </summary>
  37. </member>
  38. <member name="T:CP.Api.Areas.HelpPage.Controllers.HelpController">
  39. <summary>
  40. The controller that will handle requests for the help page.
  41. </summary>
  42. </member>
  43. <member name="M:CP.Api.Areas.HelpPage.HelpPageConfigurationExtensions.SetDocumentationProvider(System.Web.Http.HttpConfiguration,System.Web.Http.Description.IDocumentationProvider)">
  44. <summary>
  45. Sets the documentation provider for help page.
  46. </summary>
  47. <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
  48. <param name="documentationProvider">The documentation provider.</param>
  49. </member>
  50. <member name="M:CP.Api.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleObjects(System.Web.Http.HttpConfiguration,System.Collections.Generic.IDictionary{System.Type,System.Object})">
  51. <summary>
  52. Sets the objects that will be used by the formatters to produce sample requests/responses.
  53. </summary>
  54. <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
  55. <param name="sampleObjects">The sample objects.</param>
  56. </member>
  57. <member name="M:CP.Api.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleRequest(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.String,System.String)">
  58. <summary>
  59. Sets the sample request directly for the specified media type and action.
  60. </summary>
  61. <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
  62. <param name="sample">The sample request.</param>
  63. <param name="mediaType">The media type.</param>
  64. <param name="controllerName">Name of the controller.</param>
  65. <param name="actionName">Name of the action.</param>
  66. </member>
  67. <member name="M:CP.Api.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleRequest(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.String,System.String,System.String[])">
  68. <summary>
  69. Sets the sample request directly for the specified media type and action with parameters.
  70. </summary>
  71. <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
  72. <param name="sample">The sample request.</param>
  73. <param name="mediaType">The media type.</param>
  74. <param name="controllerName">Name of the controller.</param>
  75. <param name="actionName">Name of the action.</param>
  76. <param name="parameterNames">The parameter names.</param>
  77. </member>
  78. <member name="M:CP.Api.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleResponse(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.String,System.String)">
  79. <summary>
  80. Sets the sample request directly for the specified media type of the action.
  81. </summary>
  82. <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
  83. <param name="sample">The sample response.</param>
  84. <param name="mediaType">The media type.</param>
  85. <param name="controllerName">Name of the controller.</param>
  86. <param name="actionName">Name of the action.</param>
  87. </member>
  88. <member name="M:CP.Api.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleResponse(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.String,System.String,System.String[])">
  89. <summary>
  90. Sets the sample response directly for the specified media type of the action with specific parameters.
  91. </summary>
  92. <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
  93. <param name="sample">The sample response.</param>
  94. <param name="mediaType">The media type.</param>
  95. <param name="controllerName">Name of the controller.</param>
  96. <param name="actionName">Name of the action.</param>
  97. <param name="parameterNames">The parameter names.</param>
  98. </member>
  99. <member name="M:CP.Api.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleForMediaType(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue)">
  100. <summary>
  101. Sets the sample directly for all actions with the specified media type.
  102. </summary>
  103. <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
  104. <param name="sample">The sample.</param>
  105. <param name="mediaType">The media type.</param>
  106. </member>
  107. <member name="M:CP.Api.Areas.HelpPage.HelpPageConfigurationExtensions.SetSampleForType(System.Web.Http.HttpConfiguration,System.Object,System.Net.Http.Headers.MediaTypeHeaderValue,System.Type)">
  108. <summary>
  109. Sets the sample directly for all actions with the specified type and media type.
  110. </summary>
  111. <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
  112. <param name="sample">The sample.</param>
  113. <param name="mediaType">The media type.</param>
  114. <param name="type">The parameter type or return type of an action.</param>
  115. </member>
  116. <member name="M:CP.Api.Areas.HelpPage.HelpPageConfigurationExtensions.SetActualRequestType(System.Web.Http.HttpConfiguration,System.Type,System.String,System.String)">
  117. <summary>
  118. 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.
  119. The help page will use this information to produce more accurate request samples.
  120. </summary>
  121. <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
  122. <param name="type">The type.</param>
  123. <param name="controllerName">Name of the controller.</param>
  124. <param name="actionName">Name of the action.</param>
  125. </member>
  126. <member name="M:CP.Api.Areas.HelpPage.HelpPageConfigurationExtensions.SetActualRequestType(System.Web.Http.HttpConfiguration,System.Type,System.String,System.String,System.String[])">
  127. <summary>
  128. 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.
  129. The help page will use this information to produce more accurate request samples.
  130. </summary>
  131. <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
  132. <param name="type">The type.</param>
  133. <param name="controllerName">Name of the controller.</param>
  134. <param name="actionName">Name of the action.</param>
  135. <param name="parameterNames">The parameter names.</param>
  136. </member>
  137. <member name="M:CP.Api.Areas.HelpPage.HelpPageConfigurationExtensions.SetActualResponseType(System.Web.Http.HttpConfiguration,System.Type,System.String,System.String)">
  138. <summary>
  139. 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.
  140. The help page will use this information to produce more accurate response samples.
  141. </summary>
  142. <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
  143. <param name="type">The type.</param>
  144. <param name="controllerName">Name of the controller.</param>
  145. <param name="actionName">Name of the action.</param>
  146. </member>
  147. <member name="M:CP.Api.Areas.HelpPage.HelpPageConfigurationExtensions.SetActualResponseType(System.Web.Http.HttpConfiguration,System.Type,System.String,System.String,System.String[])">
  148. <summary>
  149. 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.
  150. The help page will use this information to produce more accurate response samples.
  151. </summary>
  152. <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
  153. <param name="type">The type.</param>
  154. <param name="controllerName">Name of the controller.</param>
  155. <param name="actionName">Name of the action.</param>
  156. <param name="parameterNames">The parameter names.</param>
  157. </member>
  158. <member name="M:CP.Api.Areas.HelpPage.HelpPageConfigurationExtensions.GetHelpPageSampleGenerator(System.Web.Http.HttpConfiguration)">
  159. <summary>
  160. Gets the help page sample generator.
  161. </summary>
  162. <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
  163. <returns>The help page sample generator.</returns>
  164. </member>
  165. <member name="M:CP.Api.Areas.HelpPage.HelpPageConfigurationExtensions.SetHelpPageSampleGenerator(System.Web.Http.HttpConfiguration,CP.Api.Areas.HelpPage.HelpPageSampleGenerator)">
  166. <summary>
  167. Sets the help page sample generator.
  168. </summary>
  169. <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
  170. <param name="sampleGenerator">The help page sample generator.</param>
  171. </member>
  172. <member name="M:CP.Api.Areas.HelpPage.HelpPageConfigurationExtensions.GetModelDescriptionGenerator(System.Web.Http.HttpConfiguration)">
  173. <summary>
  174. Gets the model description generator.
  175. </summary>
  176. <param name="config">The configuration.</param>
  177. <returns>The <see cref="T:CP.Api.Areas.HelpPage.ModelDescriptions.ModelDescriptionGenerator"/></returns>
  178. </member>
  179. <member name="M:CP.Api.Areas.HelpPage.HelpPageConfigurationExtensions.GetHelpPageApiModel(System.Web.Http.HttpConfiguration,System.String)">
  180. <summary>
  181. 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.
  182. </summary>
  183. <param name="config">The <see cref="T:System.Web.Http.HttpConfiguration"/>.</param>
  184. <param name="apiDescriptionId">The <see cref="T:System.Web.Http.Description.ApiDescription"/> ID.</param>
  185. <returns>
  186. An <see cref="T:CP.Api.Areas.HelpPage.Models.HelpPageApiModel"/>
  187. </returns>
  188. </member>
  189. <member name="T:CP.Api.Areas.HelpPage.ModelDescriptions.ModelDescription">
  190. <summary>
  191. Describes a type model.
  192. </summary>
  193. </member>
  194. <member name="T:CP.Api.Areas.HelpPage.ModelDescriptions.ModelDescriptionGenerator">
  195. <summary>
  196. Generates model descriptions for given types.
  197. </summary>
  198. </member>
  199. <member name="T:CP.Api.Areas.HelpPage.ModelDescriptions.ModelNameAttribute">
  200. <summary>
  201. Use this attribute to change the name of the <see cref="T:CP.Api.Areas.HelpPage.ModelDescriptions.ModelDescription"/> generated for a type.
  202. </summary>
  203. </member>
  204. <member name="T:CP.Api.Areas.HelpPage.Models.HelpPageApiModel">
  205. <summary>
  206. The model that represents an API displayed on the help page.
  207. </summary>
  208. </member>
  209. <member name="M:CP.Api.Areas.HelpPage.Models.HelpPageApiModel.#ctor">
  210. <summary>
  211. Initializes a new instance of the <see cref="T:CP.Api.Areas.HelpPage.Models.HelpPageApiModel"/> class.
  212. </summary>
  213. </member>
  214. <member name="P:CP.Api.Areas.HelpPage.Models.HelpPageApiModel.ApiDescription">
  215. <summary>
  216. Gets or sets the <see cref="P:CP.Api.Areas.HelpPage.Models.HelpPageApiModel.ApiDescription"/> that describes the API.
  217. </summary>
  218. </member>
  219. <member name="P:CP.Api.Areas.HelpPage.Models.HelpPageApiModel.UriParameters">
  220. <summary>
  221. Gets or sets the <see cref="T:CP.Api.Areas.HelpPage.ModelDescriptions.ParameterDescription"/> collection that describes the URI parameters for the API.
  222. </summary>
  223. </member>
  224. <member name="P:CP.Api.Areas.HelpPage.Models.HelpPageApiModel.RequestDocumentation">
  225. <summary>
  226. Gets or sets the documentation for the request.
  227. </summary>
  228. </member>
  229. <member name="P:CP.Api.Areas.HelpPage.Models.HelpPageApiModel.RequestModelDescription">
  230. <summary>
  231. Gets or sets the <see cref="T:CP.Api.Areas.HelpPage.ModelDescriptions.ModelDescription"/> that describes the request body.
  232. </summary>
  233. </member>
  234. <member name="P:CP.Api.Areas.HelpPage.Models.HelpPageApiModel.RequestBodyParameters">
  235. <summary>
  236. Gets the request body parameter descriptions.
  237. </summary>
  238. </member>
  239. <member name="P:CP.Api.Areas.HelpPage.Models.HelpPageApiModel.ResourceDescription">
  240. <summary>
  241. Gets or sets the <see cref="T:CP.Api.Areas.HelpPage.ModelDescriptions.ModelDescription"/> that describes the resource.
  242. </summary>
  243. </member>
  244. <member name="P:CP.Api.Areas.HelpPage.Models.HelpPageApiModel.ResourceProperties">
  245. <summary>
  246. Gets the resource property descriptions.
  247. </summary>
  248. </member>
  249. <member name="P:CP.Api.Areas.HelpPage.Models.HelpPageApiModel.SampleRequests">
  250. <summary>
  251. Gets the sample requests associated with the API.
  252. </summary>
  253. </member>
  254. <member name="P:CP.Api.Areas.HelpPage.Models.HelpPageApiModel.SampleResponses">
  255. <summary>
  256. Gets the sample responses associated with the API.
  257. </summary>
  258. </member>
  259. <member name="P:CP.Api.Areas.HelpPage.Models.HelpPageApiModel.ErrorMessages">
  260. <summary>
  261. Gets the error messages associated with this model.
  262. </summary>
  263. </member>
  264. <member name="T:CP.Api.Areas.HelpPage.HelpPageSampleGenerator">
  265. <summary>
  266. This class will generate the samples for the help page.
  267. </summary>
  268. </member>
  269. <member name="M:CP.Api.Areas.HelpPage.HelpPageSampleGenerator.#ctor">
  270. <summary>
  271. Initializes a new instance of the <see cref="T:CP.Api.Areas.HelpPage.HelpPageSampleGenerator"/> class.
  272. </summary>
  273. </member>
  274. <member name="P:CP.Api.Areas.HelpPage.HelpPageSampleGenerator.ActualHttpMessageTypes">
  275. <summary>
  276. 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"/>.
  277. </summary>
  278. </member>
  279. <member name="P:CP.Api.Areas.HelpPage.HelpPageSampleGenerator.ActionSamples">
  280. <summary>
  281. Gets the objects that are used directly as samples for certain actions.
  282. </summary>
  283. </member>
  284. <member name="P:CP.Api.Areas.HelpPage.HelpPageSampleGenerator.SampleObjects">
  285. <summary>
  286. Gets the objects that are serialized as samples by the supported formatters.
  287. </summary>
  288. </member>
  289. <member name="P:CP.Api.Areas.HelpPage.HelpPageSampleGenerator.SampleObjectFactories">
  290. <summary>
  291. Gets factories for the objects that the supported formatters will serialize as samples. Processed in order,
  292. stopping when the factory successfully returns a non-<see langref="null"/> object.
  293. </summary>
  294. <remarks>
  295. Collection includes just <see cref="M:CP.Api.Areas.HelpPage.ObjectGenerator.GenerateObject(System.Type)"/> initially. Use
  296. <code>SampleObjectFactories.Insert(0, func)</code> to provide an override and
  297. <code>SampleObjectFactories.Add(func)</code> to provide a fallback.</remarks>
  298. </member>
  299. <member name="M:CP.Api.Areas.HelpPage.HelpPageSampleGenerator.GetSampleRequests(System.Web.Http.Description.ApiDescription)">
  300. <summary>
  301. Gets the request body samples for a given <see cref="T:System.Web.Http.Description.ApiDescription"/>.
  302. </summary>
  303. <param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
  304. <returns>The samples keyed by media type.</returns>
  305. </member>
  306. <member name="M:CP.Api.Areas.HelpPage.HelpPageSampleGenerator.GetSampleResponses(System.Web.Http.Description.ApiDescription)">
  307. <summary>
  308. Gets the response body samples for a given <see cref="T:System.Web.Http.Description.ApiDescription"/>.
  309. </summary>
  310. <param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
  311. <returns>The samples keyed by media type.</returns>
  312. </member>
  313. <member name="M:CP.Api.Areas.HelpPage.HelpPageSampleGenerator.GetSample(System.Web.Http.Description.ApiDescription,CP.Api.Areas.HelpPage.SampleDirection)">
  314. <summary>
  315. Gets the request or response body samples.
  316. </summary>
  317. <param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
  318. <param name="sampleDirection">The value indicating whether the sample is for a request or for a response.</param>
  319. <returns>The samples keyed by media type.</returns>
  320. </member>
  321. <member name="M:CP.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,CP.Api.Areas.HelpPage.SampleDirection)">
  322. <summary>
  323. Search for samples that are provided directly through <see cref="P:CP.Api.Areas.HelpPage.HelpPageSampleGenerator.ActionSamples"/>.
  324. </summary>
  325. <param name="controllerName">Name of the controller.</param>
  326. <param name="actionName">Name of the action.</param>
  327. <param name="parameterNames">The parameter names.</param>
  328. <param name="type">The CLR type.</param>
  329. <param name="formatter">The formatter.</param>
  330. <param name="mediaType">The media type.</param>
  331. <param name="sampleDirection">The value indicating whether the sample is for a request or for a response.</param>
  332. <returns>The sample that matches the parameters.</returns>
  333. </member>
  334. <member name="M:CP.Api.Areas.HelpPage.HelpPageSampleGenerator.GetSampleObject(System.Type)">
  335. <summary>
  336. Gets the sample object that will be serialized by the formatters.
  337. First, it will look at the <see cref="P:CP.Api.Areas.HelpPage.HelpPageSampleGenerator.SampleObjects"/>. If no sample object is found, it will try to create
  338. one using <see cref="M:CP.Api.Areas.HelpPage.HelpPageSampleGenerator.DefaultSampleObjectFactory(CP.Api.Areas.HelpPage.HelpPageSampleGenerator,System.Type)"/> (which wraps an <see cref="T:CP.Api.Areas.HelpPage.ObjectGenerator"/>) and other
  339. factories in <see cref="P:CP.Api.Areas.HelpPage.HelpPageSampleGenerator.SampleObjectFactories"/>.
  340. </summary>
  341. <param name="type">The type.</param>
  342. <returns>The sample object.</returns>
  343. </member>
  344. <member name="M:CP.Api.Areas.HelpPage.HelpPageSampleGenerator.ResolveHttpRequestMessageType(System.Web.Http.Description.ApiDescription)">
  345. <summary>
  346. 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.
  347. </summary>
  348. <param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
  349. <returns>The type.</returns>
  350. </member>
  351. <member name="M:CP.Api.Areas.HelpPage.HelpPageSampleGenerator.ResolveType(System.Web.Http.Description.ApiDescription,System.String,System.String,System.Collections.Generic.IEnumerable{System.String},CP.Api.Areas.HelpPage.SampleDirection,System.Collections.ObjectModel.Collection{System.Net.Http.Formatting.MediaTypeFormatter}@)">
  352. <summary>
  353. 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.
  354. </summary>
  355. <param name="api">The <see cref="T:System.Web.Http.Description.ApiDescription"/>.</param>
  356. <param name="controllerName">Name of the controller.</param>
  357. <param name="actionName">Name of the action.</param>
  358. <param name="parameterNames">The parameter names.</param>
  359. <param name="sampleDirection">The value indicating whether the sample is for a request or a response.</param>
  360. <param name="formatters">The formatters.</param>
  361. </member>
  362. <member name="M:CP.Api.Areas.HelpPage.HelpPageSampleGenerator.WriteSampleObjectUsingFormatter(System.Net.Http.Formatting.MediaTypeFormatter,System.Object,System.Type,System.Net.Http.Headers.MediaTypeHeaderValue)">
  363. <summary>
  364. Writes the sample object using formatter.
  365. </summary>
  366. <param name="formatter">The formatter.</param>
  367. <param name="value">The value.</param>
  368. <param name="type">The type.</param>
  369. <param name="mediaType">Type of the media.</param>
  370. <returns></returns>
  371. </member>
  372. <member name="T:CP.Api.Areas.HelpPage.HelpPageSampleKey">
  373. <summary>
  374. This is used to identify the place where the sample should be applied.
  375. </summary>
  376. </member>
  377. <member name="M:CP.Api.Areas.HelpPage.HelpPageSampleKey.#ctor(System.Net.Http.Headers.MediaTypeHeaderValue)">
  378. <summary>
  379. Creates a new <see cref="T:CP.Api.Areas.HelpPage.HelpPageSampleKey"/> based on media type.
  380. </summary>
  381. <param name="mediaType">The media type.</param>
  382. </member>
  383. <member name="M:CP.Api.Areas.HelpPage.HelpPageSampleKey.#ctor(System.Net.Http.Headers.MediaTypeHeaderValue,System.Type)">
  384. <summary>
  385. Creates a new <see cref="T:CP.Api.Areas.HelpPage.HelpPageSampleKey"/> based on media type and CLR type.
  386. </summary>
  387. <param name="mediaType">The media type.</param>
  388. <param name="type">The CLR type.</param>
  389. </member>
  390. <member name="M:CP.Api.Areas.HelpPage.HelpPageSampleKey.#ctor(CP.Api.Areas.HelpPage.SampleDirection,System.String,System.String,System.Collections.Generic.IEnumerable{System.String})">
  391. <summary>
  392. Creates a new <see cref="T:CP.Api.Areas.HelpPage.HelpPageSampleKey"/> based on <see cref="P:CP.Api.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>, controller name, action name and parameter names.
  393. </summary>
  394. <param name="sampleDirection">The <see cref="P:CP.Api.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>.</param>
  395. <param name="controllerName">Name of the controller.</param>
  396. <param name="actionName">Name of the action.</param>
  397. <param name="parameterNames">The parameter names.</param>
  398. </member>
  399. <member name="M:CP.Api.Areas.HelpPage.HelpPageSampleKey.#ctor(System.Net.Http.Headers.MediaTypeHeaderValue,CP.Api.Areas.HelpPage.SampleDirection,System.String,System.String,System.Collections.Generic.IEnumerable{System.String})">
  400. <summary>
  401. Creates a new <see cref="T:CP.Api.Areas.HelpPage.HelpPageSampleKey"/> based on media type, <see cref="P:CP.Api.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>, controller name, action name and parameter names.
  402. </summary>
  403. <param name="mediaType">The media type.</param>
  404. <param name="sampleDirection">The <see cref="P:CP.Api.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>.</param>
  405. <param name="controllerName">Name of the controller.</param>
  406. <param name="actionName">Name of the action.</param>
  407. <param name="parameterNames">The parameter names.</param>
  408. </member>
  409. <member name="P:CP.Api.Areas.HelpPage.HelpPageSampleKey.ControllerName">
  410. <summary>
  411. Gets the name of the controller.
  412. </summary>
  413. <value>
  414. The name of the controller.
  415. </value>
  416. </member>
  417. <member name="P:CP.Api.Areas.HelpPage.HelpPageSampleKey.ActionName">
  418. <summary>
  419. Gets the name of the action.
  420. </summary>
  421. <value>
  422. The name of the action.
  423. </value>
  424. </member>
  425. <member name="P:CP.Api.Areas.HelpPage.HelpPageSampleKey.MediaType">
  426. <summary>
  427. Gets the media type.
  428. </summary>
  429. <value>
  430. The media type.
  431. </value>
  432. </member>
  433. <member name="P:CP.Api.Areas.HelpPage.HelpPageSampleKey.ParameterNames">
  434. <summary>
  435. Gets the parameter names.
  436. </summary>
  437. </member>
  438. <member name="P:CP.Api.Areas.HelpPage.HelpPageSampleKey.SampleDirection">
  439. <summary>
  440. Gets the <see cref="P:CP.Api.Areas.HelpPage.HelpPageSampleKey.SampleDirection"/>.
  441. </summary>
  442. </member>
  443. <member name="T:CP.Api.Areas.HelpPage.ImageSample">
  444. <summary>
  445. This represents an image sample on the help page. There's a display template named ImageSample associated with this class.
  446. </summary>
  447. </member>
  448. <member name="M:CP.Api.Areas.HelpPage.ImageSample.#ctor(System.String)">
  449. <summary>
  450. Initializes a new instance of the <see cref="T:CP.Api.Areas.HelpPage.ImageSample"/> class.
  451. </summary>
  452. <param name="src">The URL of an image.</param>
  453. </member>
  454. <member name="T:CP.Api.Areas.HelpPage.InvalidSample">
  455. <summary>
  456. This represents an invalid sample on the help page. There's a display template named InvalidSample associated with this class.
  457. </summary>
  458. </member>
  459. <member name="T:CP.Api.Areas.HelpPage.ObjectGenerator">
  460. <summary>
  461. This class will create an object of a given type and populate it with sample data.
  462. </summary>
  463. </member>
  464. <member name="M:CP.Api.Areas.HelpPage.ObjectGenerator.GenerateObject(System.Type)">
  465. <summary>
  466. 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:
  467. 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.
  468. Complex types: POCO types.
  469. Nullables: <see cref="T:System.Nullable`1"/>.
  470. Arrays: arrays of simple types or complex types.
  471. Key value pairs: <see cref="T:System.Collections.Generic.KeyValuePair`2"/>
  472. Tuples: <see cref="T:System.Tuple`1"/>, <see cref="T:System.Tuple`2"/>, etc
  473. Dictionaries: <see cref="T:System.Collections.Generic.IDictionary`2"/> or anything deriving from <see cref="T:System.Collections.Generic.IDictionary`2"/>.
  474. 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"/>.
  475. Queryables: <see cref="T:System.Linq.IQueryable"/>, <see cref="T:System.Linq.IQueryable`1"/>.
  476. </summary>
  477. <param name="type">The type.</param>
  478. <returns>An object of the given type.</returns>
  479. </member>
  480. <member name="T:CP.Api.Areas.HelpPage.SampleDirection">
  481. <summary>
  482. Indicates whether the sample is used for request or response
  483. </summary>
  484. </member>
  485. <member name="T:CP.Api.Areas.HelpPage.TextSample">
  486. <summary>
  487. This represents a preformatted text sample on the help page. There's a display template named TextSample associated with this class.
  488. </summary>
  489. </member>
  490. <member name="T:CP.Api.Areas.HelpPage.XmlDocumentationProvider">
  491. <summary>
  492. A custom <see cref="T:System.Web.Http.Description.IDocumentationProvider"/> that reads the API documentation from an XML documentation file.
  493. </summary>
  494. </member>
  495. <member name="M:CP.Api.Areas.HelpPage.XmlDocumentationProvider.#ctor(System.String)">
  496. <summary>
  497. Initializes a new instance of the <see cref="T:CP.Api.Areas.HelpPage.XmlDocumentationProvider"/> class.
  498. </summary>
  499. <param name="documentPath">The physical path to XML document.</param>
  500. </member>
  501. <member name="T:CP.Api.Controllers.AreaController">
  502. <summary>
  503. 获取地区
  504. </summary>
  505. </member>
  506. <member name="M:CP.Api.Controllers.AreaController.Get">
  507. <summary>
  508. 获取全部地区数据
  509. </summary>
  510. <returns></returns>
  511. </member>
  512. <member name="M:CP.Api.Controllers.AreaController.Get(System.Int32)">
  513. <summary>
  514. 获取地区彩种
  515. </summary>
  516. <returns></returns>
  517. </member>
  518. <member name="M:CP.Api.Controllers.BaseApi.ResponseOne``1(``0,System.Int32,System.String)">
  519. <summary>
  520. 统一输出方法 One
  521. </summary>
  522. <param name="data">统一的返回模型</param>
  523. <param name="code">错误代码 0为成功</param>
  524. <param name="msg">错误信息</param>
  525. <returns></returns>
  526. </member>
  527. <member name="M:CP.Api.Controllers.BaseApi.ResponseList``1(System.Collections.Generic.List{``0},System.Int32,System.String)">
  528. <summary>
  529. 统一输出方法 List
  530. </summary>
  531. <param name="data">统一的返回模型</param>
  532. <param name="code">错误代码 0为成功</param>
  533. <param name="msg">错误信息</param>
  534. <returns></returns>
  535. </member>
  536. <member name="T:CP.Api.Controllers.NewListController">
  537. <summary>
  538. </summary>
  539. </member>
  540. <member name="M:CP.Api.Controllers.NewListController.GetList(System.String,System.Int32)">
  541. <summary>
  542. </summary>
  543. <param name="ename"></param>
  544. <param name="n"></param>
  545. <returns></returns>
  546. </member>
  547. <member name="M:CP.Api.Controllers.RemoveCacheController.Get(System.String)">
  548. <summary>
  549. 清理缓存
  550. </summary>
  551. <param name="ename">彩种英文名称</param>
  552. <returns></returns>
  553. </member>
  554. <member name="M:CP.Api.Controllers.SjhandkjihController.Get(System.String,System.Int32,System.Int32,System.Int32)">
  555. <summary>
  556. 手机站试机号开机号列表
  557. </summary>
  558. <param name="ename">彩种英文名称</param>
  559. <param name="n">条数</param>
  560. <param name="qi">期数 type大于0的时候必须传入</param>
  561. <param name="type">0 默认 1 历史</param>
  562. <returns></returns>
  563. </member>
  564. <member name="T:CP.Api.Controllers.TodayController">
  565. <summary>
  566. 获取所有彩种最新开奖号码
  567. </summary>
  568. </member>
  569. <member name="M:CP.Api.Controllers.TodayController.Get(System.Int32)">
  570. <summary>
  571. 获取所有彩种最新开奖号码
  572. </summary>
  573. <param name="type">0 全部数据 1 全国 2 地方 3 高频 </param>
  574. <returns></returns>
  575. </member>
  576. <member name="T:CP.Api.Controllers.ListController">
  577. <summary>
  578. 获取n期开奖号
  579. </summary>
  580. </member>
  581. <member name="M:CP.Api.Controllers.ListController.Get(System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.Int32)">
  582. <summary>
  583. 获取n期开奖号
  584. </summary>
  585. <param name="ename">英文名称</param>
  586. <param name="n">数量 高频为天如20190101</param>
  587. <param name="y">年</param>
  588. <param name="sqi">开始期数</param>
  589. <param name="eqi">结束期数</param>
  590. <param name="type">获取历史试机号今天参数sjh</param>
  591. <param name="qi">历史试机号今天参数期数</param>
  592. <returns></returns>
  593. </member>
  594. <member name="T:CP.Api.Controllers.OneController">
  595. <summary>
  596. 获取指定期数开奖号
  597. </summary>
  598. </member>
  599. <member name="M:CP.Api.Controllers.OneController.Get(System.String,System.Int32)">
  600. <summary>
  601. 获取指定期数开奖号
  602. </summary>
  603. <param name="ename">英文名称</param>
  604. <param name="qi">期数 不传或者为0获取最近期</param>
  605. <returns></returns>
  606. </member>
  607. </members>
  608. </doc>