如何在ASP.NET Core中为类字段添加Swagger示例？

SpringFox（Swagger 2.x 版本） #

• 类字段添加@ApiModelProperty注解，通过example参数指定示例值
  示例代码：

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

@ApiModel(value = "用户信息实体")
public class User {
    @ApiModelProperty(value = "用户唯一标识ID", example = "1024")
    private Long userId;
    @ApiModelProperty(value = "用户登录名", example = "lisi")
    private String username;
    @ApiModelProperty(value = "用户实际年龄", example = "32")
    private Integer age;
}

SpringDoc（Swagger 3.x / OpenAPI 3 版本） #

• 类字段添加@Schema注解，通过example参数指定示例值
  示例代码：

import io.swagger.v3.oas.annotations.media.Schema;

@Schema(name = "用户信息实体")
public class User {
    @Schema(description = "用户唯一标识ID", example = "1024")
    private Long userId;
    @Schema(description = "用户登录名", example = "lisi")
    private String username;
    @Schema(description = "用户实际年龄", example = "32")
    private Integer age;
}

.NET 环境（Swashbuckle组件） #

• 类字段添加[SwaggerSchema]特性，通过Example参数指定示例值
  示例代码：

using Swashbuckle.AspNetCore.Annotations;

public class User
{
    [SwaggerSchema(Description = "用户唯一标识ID", Example = "1024")]
    public long UserId { get; set; }
    [SwaggerSchema(Description = "用户登录名", Example = "lisi")]
    public string Username { get; set; }
    [SwaggerSchema(Description = "用户实际年龄", Example = "32")]
    public int Age { get; set; }
}

Python FastAPI 环境 #

• 类字段添加Field参数，通过example参数指定示例值
  示例代码：

from pydantic import BaseModel, Field

class User(BaseModel):
    user_id: int = Field(description="用户唯一标识ID", example=1024)
    username: str = Field(description="用户登录名", example="lisi")
    age: int = Field(description="用户实际年龄", example=32)

内容的提问来源于stack exchange，提问作者MRP