使用Swagger和OpenApi更改了泛型类型的Json schema$ref名称

Question

我正在将我的.NET核心项目从2.2升级到3.1······

我还更新了Swagger版本，它现在是基于OpenAPI的。我从Swagger获得的API的。json模式已经更改了自定义泛型类型的$ref名称。我在很多回应中使用这些类型。

我不确定这是因为OpenApi规范，还是我没有配置正确的东西。

/// <summary>
/// Gets recording sets by search settings.
/// </summary>
/// <response code="200">The recording sets were returned correctly.</response>
/// <response code="401">The unauthorized access.</response>
/// <response code="406">The not acceptable format.</response>
/// <response code="415">The unsupported media type.</response>
/// <response code="500">The unexpected error.</response>
/// <param name="recordingSetSearchSettings">The search settings of the recording set.</param>
/// <returns>The found recording sets.</returns>
[HttpGet]
[ProducesResponseType(typeof(IDataPage<RecordingSet>), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(void), StatusCodes.Status401Unauthorized)]
[ProducesResponseType(typeof(void), StatusCodes.Status406NotAcceptable)]
[ProducesResponseType(typeof(void), StatusCodes.Status415UnsupportedMediaType)]
[ProducesResponseType(typeof(ApiErrorSummary), StatusCodes.Status500InternalServerError)]
[SwaggerOperation(OperationId = "SearchRecordingSets")]
public IDataPage<RecordingSet> Get([FromQuery(Name = "")] RecordingSetSearchSettings recordingSetSearchSettings)
{
    return recordingSetService.Search(recordingSetSearchSettings);
}

Answer 1

我在Swashbuckle github上找到了相应的答案-https://github.com/domaindrivendev/Swashbuckle.aspnetcore/issues/1803

约定已经改变，您可以使用旧的方式，定义typeextension-friendlyid并在customschemaids中使用

https://github.com/domaindrivendev/swashbuckle.aspnetcore/blob/v4.0.1/src/swashbuckle.aspnetcore.swaggergen/generator/typeextensions.cs#l10

services.AddSwaggerGen(c =>
    {
        // ... your definitions ...
        c.CustomSchemaIds(i => i.FriendlyId());
    });