如何为C# record添加OpenAPI注解？OpenApiProperty找不到问题求助

1. [OpenApiProperty]修饰record参数是否正确？ #

直接在record主构造函数参数上标注[OpenApiProperty]是不正确的。这个注解的作用目标是类的属性成员，而非构造函数参数。如果直接写在record的位置参数上，注解会被应用到构造函数参数本身，而非自动生成的对应属性，Swashbuckle无法识别这种方式。

正确的做法是使用属性目标语法，明确指定注解应用到自动生成的属性上，写法为[property: OpenApiProperty(...)]。

2. [OpenApiProperty]的来源 #

这个注解确实来自你安装的Swashbuckle.AspNetCore.Annotations包，但必须确保代码中引用了对应的命名空间：

using Swashbuckle.AspNetCore.Annotations;

缺少这个命名空间的话，编译器会无法识别该属性。

编译问题的解决步骤 #

步骤1：添加命名空间引用 #

在包含Request record的文件顶部添加：

using Swashbuckle.AspNetCore.Annotations;

步骤2：修正注解的应用目标 #

修改record的代码，给注解加上property:目标：

using Swashbuckle.AspNetCore.Annotations;

public record Request(
    [property: OpenApiProperty(Description = "AA")]
    string ClientId,
    [property: OpenApiProperty(Description = "BBB")]
    string ClientSecret);

步骤3：确认包安装状态 #

如果仍然无法编译，检查项目文件（.csproj）中是否正确包含包引用，并且已经执行了还原操作：

<PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="6.5.0" />

可以通过执行dotnet restore命令确保包已正确下载。

备选方案：显式定义record属性 #

如果你不想使用属性目标语法，也可以显式定义record的属性并直接在属性上标注注解：

using Swashbuckle.AspNetCore.Annotations;

public record Request
{
    [OpenApiProperty(Description = "AA")]
    public string ClientId { get; init; }

    [OpenApiProperty(Description = "BBB")]
    public string ClientSecret { get; init; }

    public Request(string clientId, string clientSecret)
    {
        ClientId = clientId;
        ClientSecret = clientSecret;
    }
}

内容的提问来源于stack exchange，提问作者Pure.Krome