TangSengDaoDao / TangSengDaoDaoServer

高颜值 IM 即时通讯,聊天
https://tsdaodao.com
Apache License 2.0
2.41k stars 338 forks source link

这个API接口文档展示(https://apidocs.botgate.cn/)有几个问题咨询下? #57

Closed erikluo closed 12 months ago

erikluo commented 12 months ago

问题

我发现 这个API文档展示 的很酷 , 有几个问题想请教下。 https://apidocs.botgate.cn/ 1、 看界面应该基于开源swagger搭建的, https://github.com/swagger-api/swagger-ui。 用的原生swagger吗,还是自己修改过的。 2、 API相关的规范描述swaggon.json 是自己手动编写的吗,还是工具自动生成的。

tangtaoit commented 12 months ago
  1. 用的原生的swaggerUI,没做修改
  2. api的规范是手动写的,在每个模块内,比如用户模块 https://github.com/TangSengDaoDao/TangSengDaoDaoServer/tree/main/modules/user/swagger

部署后swagger的地址 规则为: API_URL/swagger/MODULE_NAME 例如官方的用户模块的swagger地址:https://api.botgate.cn/swagger/user

erikluo commented 12 months ago
  1. 用的原生的swaggerUI,没做修改
  2. api的规范是手动写的,在每个模块内,比如用户模块 https://github.com/TangSengDaoDao/TangSengDaoDaoServer/tree/main/modules/user/swagger

部署后swagger的地址 规则为: API_URL/swagger/MODULE_NAME 例如官方的用户模块的swagger地址:https://api.botgate.cn/swagger/user

嗯, 我看官方给的运行demo中, 只能设置一个swagon文件或者url,如图: image 但实际部署时,我可能有多个服务,每个服务的API都对应1个swagger文件, 怎么让多个swagger在一个页面中以列表的形式展示呢, 就像唐僧叨叨这样: image

tangtaoit commented 12 months ago

通过swaggerUI的URLS配置 可以进行配置

image
erikluo commented 12 months ago

通过swaggerUI的URLS配置 可以进行配置

image

感谢解答~