修改kratos的openapi.yaml的operationId字段的默认值

最新推荐文章于 2024-07-20 14:28:29 发布

保持学习y

最新推荐文章于 2024-07-20 14:28:29 发布

阅读量162

点赞数 2

文章标签： go 后端

本文链接：https://blog.csdn.net/qq_41007870/article/details/140530162

版权

修改openapi.yaml的operation_id字段

使用kratos-layout写接口的时候有时候需要自定义openapi.yaml中的operationId字段。

这个字段信息是当将yaml文件导入到apifox或其它接口管理工具中的接口目录名。

如果不指定该字段，那么默认就是”服务名称_rpc函数名称“。这样很不方便查看。
在这里插入图片描述
修改显示指定名称的方式：

service User {
    // 获取模型详情信息
    rpc ModelGetInfo (ModelGetDelRequest) returns (ModelGetReply) {
        option (google.api.http) = {
            get: "/user/model"
        };
        option (openapi.v3.operation) = {
            operation_id: "模型-获取模型的详情"
        };
    }
}

在openapi.yaml中搜索查看

在这里插入图片描述