feat: 新增生成swagger文档 #3173
Merged
feat: 新增生成swagger文档 #3173
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ifooth
reviewed
May 10, 2024
| @@ -0,0 +1,96 @@ | |||
| # swagger文档生成 | |||
|
|
|||
| ## 生成文档命令 | |||
There was a problem hiding this comment.
在proto configserver的部分接口改造成这种模式
前端使用
- CreateApp
- UpdateApp
- DeleteApp
- GetApp
- Publish
- GetGroupByName
其中下面的需要可导出到蓝鲸网关
- Publish
- GetGroupByName
其他注意事项
- proto返回是一个data body，其实真正返回是有中间件包一层的，还有错误类型等可能需要文档说明(可下个PR）
ifooth
reviewed
May 10, 2024
bcs-services/bcs-bscp/Makefile
Outdated
| @@ -81,6 +81,16 @@ pb: | |||
| @cd pkg/protocol && make clean && make | |||
| @echo -e "\e[34;1mMake Protocol Done\n\033[0m" | |||
|
|
|||
| sg: | |||
There was a problem hiding this comment.
docs: api_docs bkapigw_docs
api_docs:
bkapigw_docs:
Ambition9186
force-pushed
the
feature/swagger_docs
branch
from
40dc56a
to
f9bd8db
Compare
Ambition9186
force-pushed
the
feature/swagger_docs
branch
from
f9bd8db
to
9d7ec3c
Compare
ifooth
approved these changes
May 20, 2024
Ambition9186
force-pushed
the
feature/swagger_docs
branch
from
9d7ec3c
to
ebb6817
Compare
wenxinlee2015
added a commit
that referenced
this pull request
May 23, 2024
* github-bk-bcs/master: fix: 修复客户端查询标签时输入纯数字报错问题 (#3224) refactor: 批量删除配置文件成功提示文案修改 (#3228) fix: 处理文件型服务表格滚动 (#3227) fix: 客户端查询体验优化 (#3222) fix: 新增检测客户端查询名称接口 (#3221) fix: 修复客户端统计和查询内存和cpu数据展示问题 (#3213) fix: support dualstack ip and multi ip in complex network enviroment (#3220) fix: 删除文件后恢复后需定位到刚刚恢复的配置项--bug=124360863 (#3214) fix: 文件型配置列表高度需自适应--bug=124373229 (#3219) fix: 客户端查询支持拉取时间搜索 (#3211) feat：bcs-monitor 支持 cluster-manager节点池数目趋势图 api (#3181) fix: 修复客户端下钻以及过滤客户端上报时不完整的数据 (#3206) feat: 客户端查询添加配置拉取时间范围查询 (#3212) feat: 新增生成swagger文档 (#3173) 1. 补全标准运维 离线安装和bkrepo操作文档 (#3148) feat：bcs-ui 支持自定义注册前置 (#3208) feat: bscp supports file multiple match (#3185) refactor: 业务选择组件增加虚拟滚动 (#3209) fix: 客户端统计体验优化 (#3210) fix: 去掉客户端统计饼图和旭日图选中态的黑色边框 (#3207) fix: 套餐模板中的配置文件不应该支持添加到键值型服务当中--bug=124182747 (#3205) fix: 修复文件型配置表格边框问题 (#3204)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.