接口文档推送配置

authorize-api-service/src/main/java/com/xy/service/impl/SysWorkUserServiceImpl.java

@@ -22,6 +22,7 @@ import com.xy.utils.Beans;
 import com.xy.utils.R;
 import icu.mhb.mybatisplus.plugln.core.JoinLambdaWrapper;
 import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
@@ -59,6 +60,7 @@ public class SysWorkUserServiceImpl extends ServiceImpl<SysWorkUserMapper, SysWo
 
     @Override
     @Transactional(rollbackFor = Exception.class)
+    @ApiOperation(value = "注册", notes = "注册")
     public R<Long> register(AddDto addDto) {
         //校验
         long count = count(new LambdaQueryWrapper<SysWorkUser>()
@@ -95,6 +97,7 @@ public class SysWorkUserServiceImpl extends ServiceImpl<SysWorkUserMapper, SysWo
 
     @Override
     @Transactional(rollbackFor = Exception.class)
+    @ApiOperation(value = "修改", notes = "修改")
     public R<Boolean> update(UpdateDto updateDto) {
         //更新用户信息
         SysWorkUser sysWorkUser = Beans.copy(SysWorkUser.class, updateDto)
@@ -130,6 +133,7 @@ public class SysWorkUserServiceImpl extends ServiceImpl<SysWorkUserMapper, SysWo
 
     @Override
     @Transactional(rollbackFor = Exception.class)
+    @ApiOperation(value = "删除", notes = "删除")
     public R del(DelDto delDto) {
         //删除用户角色
         sysUserRoleMapper.delete(new LambdaQueryWrapper<SysUserRole>().in(SysUserRole::getWorkUserId, delDto.getId()));
@@ -141,6 +145,7 @@ public class SysWorkUserServiceImpl extends ServiceImpl<SysWorkUserMapper, SysWo
     }
 
     @Override
+    @ApiOperation("登录")
     public R<String> login(LoginDto loginDto) {
         SysWorkUser sysWorkUser;
         //手机短信登录
@@ -183,12 +188,14 @@ public class SysWorkUserServiceImpl extends ServiceImpl<SysWorkUserMapper, SysWo
     }
 
     @Override
+    @ApiOperation("登出")
     public R logout() {
         StpUtil.logoutByTokenValue(RedisCache.getToken());
         return R.ok();
     }
 
     @Override
+    @ApiOperation("集合查询")
     public R<List<SysWorkVo>> list(ListDto listDto) {
         //条件构造
         JoinLambdaWrapper<SysWorkUser> joinLambdaWrapper = new JoinLambdaWrapper<>(SysWorkUser.class)

authorize-start/pom.xml

@@ -40,6 +40,14 @@
             <artifactId>elasticsearch</artifactId>
             <version>7.14.0</version>
         </dependency>
+
+        <!-- torna swagger 插件 -->
+        <dependency>
+            <groupId>cn.torna</groupId>
+            <artifactId>swagger-plugin</artifactId>
+            <version>1.2.18</version>
+        </dependency>
+
     </dependencies>
 
     <build>

authorize-start/src/main/java/com/xy/PushDoc.java

@@ -0,0 +1,39 @@
+package com.xy;
+
+import cn.torna.swaggerplugin.SwaggerPlugin;
+import lombok.SneakyThrows;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.boot.ApplicationArguments;
+import org.springframework.boot.ApplicationRunner;
+import org.springframework.context.annotation.Profile;
+import org.springframework.stereotype.Component;
+
+/**
+ * 指定测试环境启动运行，git push会重新启动并推送文档
+ */
+@Profile("uat")
+@Slf4j
+@Component
+public class PushDoc implements ApplicationRunner {
+
+    /**
+     * swagger文档推送到torna接口管理平台
+     */
+    @SneakyThrows
+    @Override
+    public void run(ApplicationArguments args) {
+        log.info("开始执行：swagger接口文档数据---->Torna");
+        SwaggerPlugin.pushDoc();
+        log.info("执行完成：swagger接口文档数据---->Torna");
+
+    }
+
+    /**
+     * 主动推送
+     *
+     * @param args
+     */
+    public static void main(String[] args) {
+        SwaggerPlugin.pushDoc();
+    }
+}

authorize-start/src/main/resources/torna.json

@@ -0,0 +1,18 @@
+{
+  // 开启推送
+  "enable": true,
+  // 扫描package，多个用;隔开
+  "basePackage": "com.xy.*",
+  // 推送URL，IP端口对应Torna服务器
+  "url": "http://119.96.213.127:9010/api",
+  // 模块token
+  "token": "da35918157904ccba74d1bca7d7fc867",
+  // 调试环境，格式：环境名称,调试路径，多个用"|"隔开
+  "debugEnv": "test,http://119.96.194.20:9050/",
+  // 推送人
+  "author": "xy",
+  // 打开调试:true/false
+  "debug": true,
+  // 是否替换文档，true：替换，false：不替换（追加）。默认：true
+  "isReplace": true
+}