ASP.NETCoreWebAPI-如何在Swagger文档中指定必填字段
创始人
2024-09-18 08:02:36
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);
            }

相关内容

热门资讯

前端-session、jwt 目录:   (1)session (2&#x...
linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
关于测试,我发现了哪些新大陆 关于测试 平常也只是听说过一些关于测试的术语,但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法 1. 前缀和 假设有一个数组,我们想大量频繁的去访问L到R这个区间的和,...
nodejs:本地安装nvm实... 一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本,node...
JAVA集合知识整理 Java集合知识整理 HashMap相关 HashMap的底层数据结构:jdk1.8之...
无刷直流电机介绍及单片机控制实... 无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2 1.传纸条  AcWing 275. 传纸条 - AcWing 走两条路,走一条最大的...
常用的DOS命令 常用的DOS命令 DOS(Disk Operating System,磁...
<C++> 类和对象(下) 1.const成员函数将const修饰的“成员函数”称之为const成员函数,cons...