如何从 openapi 2.0 生成的对象命名空间中删除破折号

Question

我使用Swashbuckle.AspNetCore (v4.0.1) 在asp .net core 中生成swagger.json 文件。在 Azure API 管理中导入后，我们会看到以下我们不期望的类型： SwaggerGenerationSample-Models-EmployeeArray 和 SwaggerGenerationSample-Models-EmployeeArray-1 等等。

我希望用点而不是破折号SwaggerGenerationSample.Models.EmployeeArray。

我尝试使用

CustomSchemaIds(t => t.Name), instead of CustomSchemaIds(t => t.FullName)

但由于某些重复的对象名称而无法工作(Request.Employee and Response.Employee).

我目前在 AspNetCore 中有如下配置。

services.AddSwaggerGen(config => {
   config.DescribeAllEnumsAsStrings();
   config.CustomSchemaIds(type => type.FullName);
   config.SwaggerDoc("v1", new Info { Title = "SampleAPI", Version = "v1" });
   config.MapType<decimal>(() => new Schema { Type = "number", Format = "double" });
   config.MapType<decimal?>(() => new Schema { Type = "number", Format = "double" });
 });

Answer 1

我相信，这是因为最近在 APIM 中开放 API 导入和导出的工作方式发生了变化。你可以找到语义here，因为它与之对齐。

这是相同的规范化规则：

operationId的规范化规则

• 转换为小写。
• 用单个破折号替换每个非字母数字字符序列，例如GET-/foo/{bar}?buzz={1} 将转换为 get-foo-bar-buzz-1-。
• 修剪两边的破折号，例如get-foo-bar- 将变为 get-foo-bar
• 截断以适合 76 个字符，比资源名称的最大限制少四个字符。
• 如有必要，使用剩余的四个字符作为重复数据删除后缀，形式为 -1、-2、...、-999。

你可以阅读更多关于它here:

https://blogs.msdn.microsoft.com/apimanagement/2018/04/11/important-changes-to-openapi-import-and-export/

希望对你有帮助。