相关疑难解决方法(0)

Web Api帮助页面来自多个文件的XML注释

我的Web api项目中有不同的插件和自己的XML文档,并且有一个集中的帮助页面,但问题是Web Api的默认帮助页面仅支持单个文档文件

new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/Documentation.xml"))
Run Code Online (Sandbox Code Playgroud)

如何从不同的文件加载配置?我想这样做:

new XmlDocumentationProvider("PluginsFolder/*.xml")
Run Code Online (Sandbox Code Playgroud)

asp.net documentation asp.net-web-api asp.net-web-api-helppages

22
推荐指数
4
解决办法
6768
查看次数

单独项目下的ASP.NET Web API帮助页面

我有ASP.NET Web API项目,我想添加一个帮助页面,但我希望它在一个单独的项目中.

可能吗 ?

.net c# asp.net asp.net-web-api asp.net-web-api-helppages

12
推荐指数
1
解决办法
1292
查看次数

记录复杂类型的描述

在我的API中,我试图记录不同的字段描述,但是没有一个属性似乎有效.我知道这个功能应该是最近在WebAPI 5.1中运行的(运行WebAPI.HelpPage 5.1.2).

ASP.Net Web API帮助页面:文档模型数据注释 - 工作项877

我正在尝试记录我的响应模型:

响应模型

以及各个领域/属性

物业描述

我尝试过混合使用XML注释,DataMember和Display属性,但似乎没有一个被选中.

/// <summary>
/// blah blah blah
/// </summary>
[DataContract(Name = "Application")]
public class Application
{
    /// <summary>
    /// Please Display!
    /// </summary>
    [DataMember(Order = 0)]
    [Display(Description="Please Display!")]
    [StringLength(11, MinimumLength = 11)]
    public string ApplicationId { get; set; }
Run Code Online (Sandbox Code Playgroud)

以下是我的Areas/HelpPage/App_Start/HelpPageConfig.cs中的示例

namespace WebAPI.Areas.HelpPage
{
    #pragma warning disable 1591
    /// <summary>
    /// Use this class to customize the Help Page.
    /// For example you can set a custom <see cref="System.Web.Http.Description.IDocumentationProvider"/> to supply …
Run Code Online (Sandbox Code Playgroud)

c# asp.net-web-api asp.net-web-api-helppages

7
推荐指数
1
解决办法
1750
查看次数

Swashbuckle - 将模型和示例值从另一个项目的模型添加到 Swagger UI

我正在使用 Swagger 来记录我的.NET C#API,当我的模型在另一个项目上时,Swagger 只是崩溃并且不加载任何东西。

当我WebAPI从 Visual Studio加载示例项目时,它使用同一项目中的模型并且可以正常工作:

Visual Studio 示例项目示例图像

但是,当我使用其他项目中的模型时,它会在加载任何内容之前崩溃。

我有一个 API 项目和一个业务项目。我的模型是在我的商业项目中存储(并在其他项目之间共享,因此需要)的视图模型。

有什么方法可以向 Swagger 表明我的模型定义在哪里?

.net c# swagger visual-studio-2015 swashbuckle

6
推荐指数
2
解决办法
2万
查看次数