相关疑难解决方法(0)

Web Api的Xml文档如何包含主项目之外的文档?

将XmlDoc集成到Web Api项目中的文档似乎只处理所有API类型都属于WebApi项目的情况.特别是,它讨论了如何将XML文档重新路由到App_Data/XmlDocument.xml取消注释配置中将使用该文件的行.这隐含地只允许一个项目的文档文件.

但是,在我的设置中,我在一个常见的"模型"项目中定义了我的请求和响应类型.这意味着如果我有一个端点,例如:

[Route("auth/openid/login")]
public async Task<AuthenticationResponse> Login(OpenIdLoginRequest request) { ... }
Run Code Online (Sandbox Code Playgroud)

OpenIdLoginRequest单独的C#项目中定义的位置如下:

public class OpenIdLoginRequest
{
    /// <summary>
    /// Represents the OpenId provider that authenticated the user. (i.e. Facebook, Google, etc.)
    /// </summary>
    [Required]
    public string Provider { get; set; }

    ...
}
Run Code Online (Sandbox Code Playgroud)

尽管有XML文档,但request在查看特定于端点的帮助页面(即http://localhost/Help/Api/POST-auth-openid-login)时,参数的属性不包含任何文档.

如何在Web API XML文档中显示具有XML文档的子项目中的类型?

c# xml-documentation asp.net-web-api

100
推荐指数
3
解决办法
3万
查看次数

为 swagger 的“试用”指定示例请求

有没有办法指定 swagger 的示例请求?甚至可能是多个?

Try it out按钮仅显示通用值,例如:

{
    "firstName": "string",
    "lastName": "string"
}
Run Code Online (Sandbox Code Playgroud)

为了

public class User
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
}
Run Code Online (Sandbox Code Playgroud)

当您必须首先编辑所有值时,使用大型对象变得非常困难。我知道我可以使用 Postman,我也可以使用,但是能够使用 swagger创建多个美观且有用的示例会非常好。

c# json http-post swagger asp.net-core-webapi

5
推荐指数
2
解决办法
2063
查看次数