文档

https://learn.microsoft.com/zh-cn/aspnet/core/fundamentals/minimal-apis?view=aspnetcore-10.0

使用 OpenAPI

builder.Services.AddOpenApi(options =>
{
    // 默认3.1可以自定义(3.0)
    options.OpenApiVersion = Microsoft.OpenApi.OpenApiSpecVersion.OpenApi3_0;
});

app.MapOpenApi();

OpenAPI 元数据

Metadata	Attribute	miniapi扩展方法	其他策略
摘要	[EndpointSummary]	WithSummary
description	[EndpointDescription]	WithDescription
tags	[Tags]	WithTags
operationId	[EndpointName]	WithName
parameters	[FromQuery]、[FromRoute]、 [FromHeader]、 [FromForm]
参数说明	[Description]
requestBody	[FromBody]	Accepts
responses	[Produces]	Produces、ProducesProblem	TypedResults
排除端点	[ExcludeFromDescription]、[ApiExplorerSettings]

属性添加元数据

Attribute	Description
[Description\]	设置架构中属性的 description。
[Required\]	在架构中将属性标记为 required。
[DefaultValue\]	设置架构中属性的 default 值。
[Range\]	设置整数或数字的 minimum 和 maximum 值。
[MinLength\]	设置字符串的 minLength 或数组的 minItems。
[MaxLength\]	设置字符串的 maxLength 或数组的 maxItems。
[RegularExpression\]	设置字符串的 pattern。