ASP.NETCoreWebAPI-如何在Swagger文档中指定必填字段
创始人
2024-09-18 08:01:17
0
  1. 在定义 API 输入模型时,使用 RequiredAttribute 标注必填字段:
public class InputModel
{
    [Required]
    public string RequiredField { get; set; }

    public string OptionalField { get; set; }
}
  1. 使用 Swashbuckle.AspNetCore 库(Swagger 的 .NET 实现)自定义 Schema 操作,将 RequiredAttribute 的信息添加到 Swagger 文档中。

在 Startup.cs 文件中的 ConfigureServices 方法中,添加以下代码:

services.AddSwaggerGen(config =>
{
    // ... [其他 Swagger 配置]

    // 定义一个方法,用于获取指定类型的属性是否必填
    Func isRequiredProperty = (type, propertyName) =>
    {
        var propertyInfo = type.GetProperty(propertyName);
        if (propertyInfo == null) return false;
        return Attribute.IsDefined(propertyInfo, typeof(RequiredAttribute));
    };

    // 使用 Swashbuckle.AspNetCore 库提供的 SchemaFilter 接口
    config.SchemaFilter(isRequiredProperty);

    // ... [其他 Swagger 配置]
});

然后,在当前项目的根目录添加一个 RequiredSchemaFilter.cs 文件,实现 Swashbuckle.AspNetCore 库的 ISchemaFilter 接口:

using System;
using System.Linq;
using System.Reflection;
using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;

public class RequiredSchemaFilter : ISchemaFilter
{
    private readonly Func _isRequiredProperty;

    public RequiredSchemaFilter(Func isRequiredProperty)
    {
        _isRequiredProperty = isRequiredProperty;
    }

    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
    {
        if (schema == null || context == null || context.Type == null) return;

        foreach (var propertyName in schema.Properties.Keys.ToArray())
        {
            var propertyInfo = context.Type.GetProperty(propertyName, BindingFlags.IgnoreCase | BindingFlags.Public | BindingFlags.Instance);
            if (propertyInfo == null) continue;

            if (_isRequiredProperty(context.Type, propertyName))
            {
                schema.Required.Add(propertyName);
            }

相关内容

热门资讯

玩家必备攻略!德州透视hhpo... 玩家必备攻略!德州透视hhpoker,wpk俱乐部是做什么的,真是是真的有挂(有挂秘诀)所有人都在同...
9分钟了解!拱趴大菠萝有什么挂... 9分钟了解!拱趴大菠萝有什么挂,hhpoker免费辅助器,本来真的有挂(竟然有挂)9分钟了解!拱趴大...
每日必备!德州局透视,如何判断... 每日必备!德州局透视,如何判断wpk辅助软件的真假,真是存在有挂(有挂存在)1、下载好脚本下载之后点...
推荐十款!hhpoker智能辅... 推荐十款!hhpoker智能辅助插件,hhpoker免费透视脚本,好像是有挂(发现有挂)1、游戏颠覆...
普及知识!哈糖大菠萝有挂吗,a... 普及知识!哈糖大菠萝有挂吗,aa poker透视软件,好像真的有挂(有挂实锤)1、金币登录送、破产送...
我来教教你!wpk辅助插件,佛... 我来教教你!wpk辅助插件,佛手在线大菠萝辅助,本来存在有挂(有挂透视)运佛手在线大菠萝辅助辅助工具...
分辨真假!pokernow辅助... 分辨真假!pokernow辅助控制,wepoker好友助力码,一贯有挂(有挂分析)小薇(辅助器软件下...
最新技巧!fishpoker透... 最新技巧!fishpoker透视底牌,wpk透视辅助靠谱吗,总是是真的有挂(有挂秘笈)1、最新技巧!...
三分钟了解!wpk有作弊吗,有... 三分钟了解!wpk有作弊吗,有哪些免费的wpk作弊码,总是真的是有挂(有挂细节)在进入软件靠谱后,参...
带你了解!wpk私人局辅助是真... 带你了解!wpk私人局辅助是真的吗,sohoo辅助,总是真的是有挂(证实有挂)1、玩家可以在线上大神...