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);
            }

相关内容

热门资讯

线上(wepoke真的)原来是... 线上(wepoke真的)原来是真的有挂!其实真的有挂(2022已更新)(哔哩哔哩);亲,其实确实真的...
两教程(Wepoke程序)软件... 两教程(Wepoke程序)软件透明挂辅助工具(软件透明挂)透视辅助(2024已更新)(哔哩哔哩);致...
软件(wepoke透明)原来是... 软件(wepoke透明)原来是真的有挂!其实真的有挂(2020已更新)(哔哩哔哩)是一款可以让一直输...
一模拟器(德扑工具)外挂辅助工... 一模拟器(德扑工具)外挂辅助工具(透视)透视辅助(2025已更新)(哔哩哔哩);亲真的是有正版授权,...
系统(aapoker讲解)竟然... 系统(aapoker讲解)竟然真的有挂!其实真的有挂(2021已更新)(哔哩哔哩);aapoker讲...
6系统(aapoker下载)外... 6系统(aapoker下载)外挂辅助工具(辅助挂)透视辅助(2023已更新)(哔哩哔哩)aapoke...
智能(德扑之星刷数据)果真真的... 智能(德扑之星刷数据)果真真的有挂!原来真的有挂(2025已更新)(哔哩哔哩);《WPK辅助透视》‌...
1机器人(德州nzt软件)软件... 1机器人(德州nzt软件)软件透明挂辅助软件(透视)透视辅助(2022已更新)(哔哩哔哩);人气非常...
ai代打(德扑之星决策)确实是... ai代打(德扑之星决策)确实是真的有挂!原来真的有挂(2020已更新)(哔哩哔哩);科技详细教程小薇...
第8透明(wepoke数据)外... 第8透明(wepoke数据)外挂透明挂辅助神器(辅助挂)透视辅助(2023已更新)(哔哩哔哩);原来...