asp.net-web-api-helppages相关内容
我的 ASP.NET Web API 帮助页面使用 XML 文档 如下所示.我想知道是否有办法在评论中包含 html,以便将其呈现在网页上,而不是被删除/忽略/转义. 具体来说,我正在寻找一种创建换行符的方法,但是能够创建项目符号列表等会很棒! 例如/我希望能够做这样的事情: ///////SalesDocument 的 CRUD 操作 ///这是一个新行///[RoutePr
..
我已按照 MSDN 和其他 SO 问题,以设置文档并在帮助页面的描述部分显示 XML 注释.但是,当我尝试构建或运行项目时收到错误.Visual Studio 2017 在属性中不再有“构建"选项.它已被“编译"部分取代.虽然此部分确实有“生成 XML 文档文件"选项,但它没有 XML 文档文件位置选项(如 MSDN 说明中所述).话虽如此,我们知道 XmlDocumentProvider 正在
..
我正在开发一个API,该API根据用户输出不同的响应,并且我当前正在使用ResponseType属性来描述返回的响应类型,但这仅允许我指定一种响应类型,用户之间会有所不同. 有什么方法可以自定义帮助页面以显示用户将获得的响应类型? 解决方案 帮助页面不支持这些动态响应类型,而是依赖于可用的静态信息. HelpPage不支持前面提到的多种响应类型...事实上,我们允许 Respo
..
我已经在VS 2010中使用较旧的WCF框架开发了许多内部REST接口。对于DEV和QA平台,它能够生成帮助页面的功能非常方便,但是对于生产版本而言,很容易禁用 web.config 文件中的以下帮助页面:
..
我很难为Web api控制器填充帮助页面.控制器中唯一的方法如下: public HttpResponseMessage Get(string p1,string p2= "blend", string p3 = "blend") 方法显示在帮助页面上,并带有签名: GET api/mycontroller?p1={p1}&p2={p2}&p3={p3} 但是,我的评论都没有流
..
我有一个项目,我想在其中使用具有自定义类型的路由属性. 我将自定义类型用作查询参数的以下代码可以正常工作,并且帮助页面显示该自定义类型. // GET api/values?5,6 [Route("api/values")] public string Get(IntegerListParameter ids) { return "value"; } WebApi.HelpPag
..
我将XML文档用于ASP.NET Web API帮助页面如此处所示. 我想知道是否有一种方法可以在评论中包含html,以便将其呈现在网页上,而不是将其删除/忽略/转义. 具体来说,我正在寻找一种创建换行符的方法,但是能够创建项目符号列表等会很棒! Ex/我希望能够执行以下操作: /// /// CRUD operations for SalesDocument
..
有没有一种方法可以使ApiExplorer自动生成请求样本? 我尝试使用: config.SetActualResponseType(typeof(SomeType), "ControllerName", "Post"); 在HelpPageConfig.cs中,但是出现了两个问题: 这需要我为特定控制器和动作定义特定类型,并且我正在寻找更通用的东西,如果不需要,则不需要添
..
我已经阅读这里关于web API帮助页面的其他信息。数据注释实际上提供了文档的附加信息。但是我想知道,无论如何提供额外的信息,没有数据注释? 如果是,那么如何? 如果不是,那么有没有办法用数据注释覆盖附加信息,例如 [必需] 显示需要写入其他信息,但如果要显示“此字段是必需的”或类似的内容? / p> 谢谢 编辑看到我想更新没有数据的附加
..
我有我的网络api,我添加了 web api帮助页面自动生成我的文档。对于我的参数列出的方法,这是非常有用的,但我有一个这样的方法: public SessionResult PostLogin(CreateSessionCommand request ) 而且,在我的帮助页面上,它只在属性部分列出了命令参数。但是,在示例请求部分中,它列出了我的 CreateSession
..
我正在开发一个Web-API项目,我对Microsoft的帮助页面的自动生成的文档印象深刻。 我启用了自定义文档官方网站创建帮助页面 文档生成成功但是没有从 ; 标签似乎被添加到描述中,HelpPages只是忽略它们(这是一个原因)。 我真的想拥有功能在我的项目,我搜索了很多(有时接近),但没有一个给出了令人信服的答案。 这就是为什么我决定发布
..
我无法搞清楚如何获得帮助页面在我的Web API来显示除无其他资源说明什么。它IHttpActionResult链接,然后选择“无”。之后。我得到了我的样品中加入 config.SetActualResponseType(typeof运算(的ComplexType),“控制器”,“行动”)的工作; 来HelpPageConfig.cs。我的控制器看起来是这样的: ///<总结> /
..
我收到我的
..
我使用的ASP.NET Web API一个REST API开发的。我用帮助页面的NuGet包,以创建文档。我所遇到的一个问题是以下内容。对于我的模型对象,我有XML文档注释并成为他们的帮助页面为模型的每个成员描述。我想说明的某一部分是一个新行,但一切都在评论当属一个段落。我尝试添加< BR /> 的意见,但没有帮助。有谁知道如何实现这一目标? 解决方案 一个类似的问题已经在这里
..
我使用的Web API帮助页面使用Web API 2(5.0) - 无论是最新的NuGet包。我想帮助文档上显示的是参数或在身体恢复类的属性意见的Htt presponseMessage。 例如,我有这样一个控制器的方法: 公开的Htt presponseMessage邮报([FromBody] MyClassType1 MyClass的) { //为清楚起见业务逻辑中删除 返
..
我试图用<见CREF =“”> 在我的API我的XML文档标记的标签,但他们都上来了帮助空白页面。 因此,对于描述我想它说: “获取或设置值相关的项目的。” 其中的项目的是在API中对另一个对象的链接。 相反,我越来越: “获取或设置值相关联的。” 所以<见CREF =“”> 标签被忽略。我甚至已经利用例子这里以防万一我的声明是错误的尝试,但没'T的工作无论
..
为了使用Web API帮助页面我的Web API项目生成XML文档,我不得不检查下的“构建”我的项目属性的部分“XML文档文件”选项。当我建立本地本正确生成的文档。 然而,当我检查,我得到的生成服务器上出现以下错误: CSC:错误生成XML文档文件 “C:\\构建\\ 3 \\来源\\ CURRENTVERSION \\项目名\\程序App_Data \\ XmlDocument.xml
..
我使用的Web API帮助页面和我希望能够包括链接到其他的方法。我从
..
我已经安装了正确的包网页API 2 安装封装Microsoft.AspNet.WebApi.HelpPage - pre 但帮助区域没有被映射,并返回404(网页API工作的罚款)。我使用Microsoft.Owin.Host.SystemWeb作为主机。下面是我启动code。公共类启动 { 公共无效配置(IAppBuilder应用程序) {
..
我使用的XML文档为我的ASP.NET Web API帮助页面的如下所示。 我想知道如果有一种方法可以包括这样它就会在网页上呈现的意见HTML,而不是它被删除/忽略/逃过一劫。 具体来说,我正在寻找一种方法来创建一个换行符,但能够创建项目列表等,将是伟大的! 防爆/我希望能够做这样的事: ///<总结> ///为SalesDocument&LT CRUD操作; BR
..