Tag: asp.net web api helppages

API文档中的自定义附加信息

我在这里阅读了有关Web API帮助页面的其他信息。 数据注释实际上提供了文档的附加信息。 但我想知道，无论如何都要提供没有数据注释的附加信息？ 如果是，那怎么样？ 如果没有，那么无论如何都要用数据注释覆盖附加信息，例如 [Required] 显示需要写入附加信息，但如果我想显示“此字段是必需的”或类似的内容怎么办？ 谢谢 编辑参见图片我希望在没有数据注释的情况下更新其他信息（如果可能）。

WebAPI帮助页面 – 返回或参数模型/类属性的文档

我正在使用Web API帮助页面与Web API 2（5.0） – 两个最新的Nuget包。 我想帮助文档显示属性的注释，这些类是参数或在HttpResponseMessage的主体中返回。 例如，我有一个像这样的控制器方法： public HttpResponseMessage Post([FromBody] MyClassType1 myClass) { // Business logic removed for clarity return Request.CreateResponse(HttpStatusCode.OK, new MyClassType2()); } 我希望MyClassType1和MyClassType2上的XML注释显示在上述post操作的帮助页面上。 我看过的所有地方，到目前为止看来还没有支持。 但是，我想知道是否有人能通过扩展ApiExplorer，添加到XmlDocumentationProvider等来实现这一点？ 我知道注释和属性包含在生成的XML文件中，所以我可以尝试手动解析（所有参数和返回类型都在MyAssemblyName.Models命名空间中，所以我的想法是我可以查找XML具有以该命名空间开头的成员名称的节点。但是，我知道内置的Web API帮助页面具有一些缓存function，所以我更喜欢以某种方式将其与现有function相结合（只需添加它）。 我已经设法通过更新Parameters.cshtml模板来显示参数的类型（仅向下一层）： @using System.Reflection @using System.Threading @using System.Web.Http.Description @using Regency.API.Services.Areas.HelpPage @model System.Collections.ObjectModel.Collection NamePropertiesDescriptionAdditional information @foreach (ApiParameterDescription parameter in Model) { string parameterDocumentation = parameter.Documentation ?? “No […]

ASP Web API帮助页面 – 从XML 标记链接到类

我正在开发一个Web-API项目，我对微软的HelpPages自动生成的文档印象非常深刻。 我使用官方网站创建帮助页面启用自定义文档 文档生成成功但是标签中的类的引用似乎都没有添加到描述中，HelpPages只是忽略它们（这是有原因的）。 我真的很想在我的项目中使用这个function，我搜索了很多（有时候很近），但没有一个给出令人信服的答案。 这就是为什么我决定将我的解决方案发布到这个调整，并希望有利于其他程序员，并节省他们一些时间和精力。 （我的回答在下面的回复中）

WebAPI帮助页面：禁用生产版本

我在VS 2010中使用旧的WCF框架开发了许多内部REST接口。它生成帮助页面的能力对DEV和QA平台来说很方便，但对于生产版本，很容易禁用这些帮助页面的生成在web.config文件中： 我现在正在继续使用WebAPI框架（目前在VS 2012上使用版本1），但是关闭此function似乎并不简单（即我找不到任何有关如何执行此操作的信息）一个web.config文件）。 当然，我可以继续在代码本身内手动执行此操作，但肯定有一种更简单的方法; 类似于WCF如上所述的做法。 我想使用web.config文件方法，因为我已经为其他设置准备了web.release.config转换文件。 任何关于此的最佳实践的想法将不胜感激。