Swagger Codegen IO：更改服务命名约定和昵称

Question

在创建 Angular ZDB974238714CA38DE634A7CE10 时，是否有覆盖 Swagger IO CodeGen 命名约定？

https://editor.swagger.io/

其命名方式如下：API + Controller 名称 + Controller 方法 + Z293C9EA246FF9985DC6F62A650F78 动作。

public apiProductGetProductByProductIdGet(productNumber?: string, observe?: 'body', reportProgress?: boolean): Observable<ProductResponse>;

我们想为我们公司重组/重新排序命名约定。

目前将 Net Core 3 API 与 Angular Typescript 链接。

将接受 CodeGen 的 javascript 答案。

更新可能的解决方案：

如何更改 C# 中的昵称属性？

https://docs.swagger.io/spec.html

“昵称。操作的唯一 id，可以由读取 output 的工具使用，以便进一步和更轻松地操作。例如，Swagger-Codegen 将使用昵称作为它生成的客户端中操作的方法名称。该值必须是字母数字，可以包含下划线。不允许使用空白字符。

"nickname": "addPet",

Answer 1

您正在寻找operationId属性：

operationId是用于标识操作的可选唯一字符串。 如果提供，这些 ID 在 API 中描述的所有操作中必须是唯一的。

https://swagger.io/docs/specification/paths-and-operations/

例子：

/users:
  get:
    operationId: getUsers
    summary: Gets all users
    ...
  post:
    operationId: addUser
    summary: Adds a new user
    ...
/user/{id}:
  get:
    operationId: getUserById
    summary: Gets a user by user ID
    ...

如果您使用的是Swashbuckle ，您可以通过以下几种不同的方式指定 operationId：

[HttpGet("{id:int}", Name = nameof(GetProductById))]
public IActionResult GetProductById(int id) // operationId = "GetProductById"'

或者

[HttpGet("{id:int}", Name = "GetProductById")]
public IActionResult GetProductById(int id) // operationId = "GetProductById"'

另请参阅

Answer 2

您还可以使用标签更改生成的客户端 SDK 服务命名约定（如果您像我一样并想防止与客户端服务发生冲突）。

您可以使用user-api的标签，而不是标记为user ，让客户端 SDK 生成服务名称为UserService ，生成的库服务将命名为UserApiService 。

https://swagger.io/docs/specification/2-0/grouping-operations-with-tags/