C# 根据模型使用Swagger生成示例请求_C#_.net_.net Core_Swagger_Swashbuckle

C# 根据模型使用Swagger生成示例请求

c# .net .net-core swagger

C# 根据模型使用Swagger生成示例请求,c#,.net,.net-core,swagger,swashbuckle,C#,.net,.net Core,Swagger,Swashbuckle,大家好。请告诉我。我是否可以根据模型在Swagger中生成示例请求，以避免手动编写。查看模型具有哪些字段。甚至可能吗？因为现在我必须手动为每个api编写请求的描述。我想自动化这个过程。我使用的是Swashback和ASP.NET Core这里有代码示例，您应该在模型上添加///123，而不是注释这是否接近您需要的：代码如下：您还可以使用IDocumentFilter进行动态更改，如下所示： private class AddExampleDocumentFilter

大家好。请告诉我。我是否可以根据模型在Swagger中生成示例请求，以避免手动编写。查看模型具有哪些字段。
甚至可能吗？
因为现在我必须手动为每个api编写请求的描述。
我想自动化这个过程。

我使用的是Swashback和ASP.NET Core

这里有代码示例，您应该在模型上添加

///123

，而不是注释

这是否接近您需要的：

代码如下：

您还可以使用

IDocumentFilter

进行动态更改，如下所示：

    private class AddExampleDocumentFilter : IDocumentFilter
    {
        private List<Guid> Guids
        {
            get
            {
                return new List<Guid>
                {
                    Guid.Empty, Guid.Empty
                };
            }
        }

        public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry s, IApiExplorer a)
        {
            if (swaggerDoc.paths.ContainsKey("/api/Dictionary"))
            {
                var del = swaggerDoc.paths["/api/Dictionary"].delete;
                if (del != null)
                {
                    del.parameters[0].schema.example = Guids;
                }
            }
        }
    }

私有类AddExampleDocumentFilter:IDocumentFilter
{
私有列表GUID
{
得到
{
返回新列表
{
Guid.Empty，Guid.Empty
};
}
}
公共无效应用（Swagger文档Swagger文档、SchemaRegistry s、IApiExplorer a）
{
if（swaggerDoc.path.ContainsKey（“/api/Dictionary”））
{
var del=swaggerDoc.path[“/api/Dictionary”]。删除；
如果（del！=null）
{
del.parameters[0].schema.example=Guids；
}
}
}
}

结果如下：

一旦用户使用示例数据执行它，UI就会显示curl请求：

有一个放置代码示例的地方，您应该在模型上添加

///123

，而不是添加注释