当前位置: 首页 > 知识库问答 >
问题:

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

余阳秋
2023-03-14

在创建角API服务代理时,是否有任何方法可以重写大摇大摆的IO代码根命名约定?

https://editor.swagger.io/

它的命名由以下等式进行:API+控制器名称+控制器方法+HTTP操作。

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

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

“昵称。操作的唯一id,可由读取输出的工具使用,以便进一步和更容易地操作。例如,Swagger-Codegen将在它生成的客户端中使用昵称作为操作的方法名。该值必须是字母数字,并且可以包括下划线。不允许使用空格字符。

"nickname": "addPet",

共有1个答案

阴飞星
2023-03-14

您正在查找operationid属性:

operationid是用于标识操作的可选唯一字符串。如果提供了这些ID,这些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
    ...
[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"'
 类似资料:
  • 为了在跨API开发中向开发者提供一致的开发体验,所有的命名应该保证: 简单 直观 一致 这适用于接口、资源、集合、方法以及消息的命名。 因为很多开发者并非以英语作为母语,所以命名约定的目标之一是确保大多数开发者可以更容易理解 API。对于方法和资源,我们鼓励使用简单、直观和一致的单词来命名。 API 中的命名应该使用正确的美式英语。例如,使用美式英语的 license 而非英式英语的 licenc

  • 在本节,我们不会讨论适用于大规模和可维护的最佳 CSS 命名方案,因为这不仅仅超过了个人的能力范围,也不是一个Sass样式指南可以解决的问题。我个人推荐遵从 CSS Guidelines 的建议。 良好的命名对保持整体代码的一致性和可读性非常重要,在 Sass 中可以命名的地方如下: 变量; 函数; 混合宏。 由于 Sass 占位符遵循和类名相同的命名模式,因此被视为常规的 CSS 选择器,也就在

  • 函数名 小技巧 使用小写字母,并用下划线分隔单词。使用双冒号 :: 分隔库。函数名之后必须有圆括号。关键词 function 是可选的,但必须在一个项目中保持一致。 如果你正在写单个函数,请用小写字母来命名,并用下划线分隔单词。如果你正在写一个包,使用双冒号 :: 来分隔包名。大括号必须和函数名位于同一行(就像在Google的其他语言一样),并且函数名和圆括号之间没有空格。 # Single fu

  • 问题内容: 我的完整变量名称是“唯一代码”,但是我希望此变量是“ ucode” -ish。 那么考虑Java命名约定是正确的吗? 编码 uCode UCode 问题答案: 请参阅编码约定。对于变量,建议使用驼峰式大小写。回覆。命名,我本以为 将是最合乎逻辑的选择(我知道那不在您的选择列表中)。任何变体在我看来都是 unicode 的缩写,我认为这是一种误导。以上不是一个太长的名称(例如,它不是Ab

  • 问题内容: 按照目前的情况,这个问题并不适合我们的问答形式。我们希望答案得到事实,参考或专业知识的支持,但是这个问题可能会引起辩论,争论,民意调查或扩展讨论。如果您认为此问题可以解决并且可以重新提出,请访问帮助中心以获取指导。 7年前关闭。 我知道关于哪种命名约定最适合JavaScript的争论很多(也许没有争议,但至少有争论)。 您如何命名变量,函数,对象等? 我将对此保留自己的想法,因为我已经

  • 问题内容: JSON命名有标准吗?我看到大多数示例都使用所有小写字母,并用下划线(lower_case)分隔。但是,可以使用PascalCase或camelCase吗? 问题答案: 目前尚无SINGLE标准,但我已经看到您提到的3种样式(“ Pascal / Microsoft”,“ Java”()和“ C”(下划线,))以及至少另外一种样式,例如)。 这似乎主要取决于所涉及服务的背景开发人员。具