Jelajahi Sumber

增加接口描述

longhu 2 minggu lalu
induk
melakukan
6218c50bb5

+ 9 - 12
pom.xml

@@ -111,19 +111,21 @@
             <version>2.0.57</version>
         </dependency>
 
+
         <dependency>
             <groupId>com.basedevelop</groupId>
             <artifactId>basedevelop</artifactId>
             <version>1.0-SNAPSHOT</version>
         </dependency>
 
-
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-data-jpa</artifactId>
         </dependency>
 
 
+
+
         <dependency>
             <groupId>org.mybatis.spring.boot</groupId>
             <artifactId>mybatis-spring-boot-starter</artifactId>
@@ -396,25 +398,20 @@
             <id>deploy</id>
 
             <build>
+                <finalName>${project.artifactId}</finalName>
                 <plugins>
                     <plugin>
-                        <artifactId>maven-jar-plugin</artifactId>
+                        <groupId>org.springframework.boot</groupId>
+                        <artifactId>spring-boot-maven-plugin</artifactId>
                         <executions>
                             <execution>
-                                <id>client</id>
-                                <goals><goal>jar</goal></goals>
-                                <phase>package</phase>
-                                <configuration>
-                                    <classifier>client</classifier>
-                                    <includes>
-                                        <include>**/fegin/**</include>
-                                    </includes>
-                                </configuration>
+                                <goals>
+                                    <goal>repackage</goal>
+                                </goals>
                             </execution>
                         </executions>
                     </plugin>
                 </plugins>
-
             </build>
         </profile>
         <profile>

+ 0 - 2
src/main/java/com/hr/InterfacePlatformApplication.java

@@ -1,7 +1,5 @@
 package com.hr;
 
-
-import com.yy.basedevelop.BasedevelopBoot;
 import lombok.extern.slf4j.Slf4j;
 import org.mybatis.spring.annotation.MapperScan;
 import org.springframework.boot.SpringApplication;

+ 1 - 1
src/main/java/com/hr/controller/IpAccountController.java

@@ -34,7 +34,7 @@ public class IpAccountController{
      */
     @Operation(summary = "分页查询")
     @GetMapping
-    public BasePageResult<IpAccountVO> paginQuery(@RequestBody IpAccountParam ipAccountParam){
+    public BasePageResult<IpAccountVO> paginQuery(IpAccountParam ipAccountParam){
         Page<IpAccountVO> ipAccountPOS = ipAccountService.paginQuery(ipAccountParam, ipAccountParam.getPageNum(), ipAccountParam.getPageSize());
         return BasePageResult.success(ipAccountPOS.getContent(), ipAccountPOS.getTotalElements(), ipAccountParam.getPageNum(), ipAccountParam.getPageSize());
     }

+ 10 - 9
src/main/java/com/hr/vo/AiwenParseIpInfoVO.java

@@ -1,5 +1,6 @@
 package com.hr.vo;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 /**
@@ -10,22 +11,22 @@ import lombok.Data;
  */
 @Data
 public class AiwenParseIpInfoVO {
-    /** ip地址 */
+    @Schema(description = "ip地址")
     private String ip;
-    /** 国家 */
+    @Schema(description = "国家")
     private String country;
-    /** 省份 */
+    @Schema(description = "省份")
     private String province;
-    /** 城市 */
+    @Schema(description = "城市")
     private String city;
-    /** 运营商 */
+    @Schema(description = "运营商")
     private String sub;
-    /** 其他信息, 例子: 中国|0|重庆|重庆市|电信 */
+    @Schema(description = "其他信息, 例子: 中国|0|重庆|重庆市|电信")
     private String info;
-    /** 纬度信息 */
+    @Schema(description = "纬度信息")
     private String lat;
-    /** 经度信息 */
+    @Schema(description = "经度信息")
     private String lng;
-    /** 城市code, 接口未返回, 为预留字段 */
+    @Schema(description = "城市code, 接口未返回, 为预留字段")
     private String cityCode;
 }

+ 11 - 10
src/main/java/com/hr/vo/IpAccountVO.java

@@ -1,6 +1,7 @@
 package com.hr.vo;
 
 import com.fasterxml.jackson.annotation.JsonFormat;
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.persistence.Entity;
 import jakarta.persistence.Id;
 import lombok.Data;
@@ -16,26 +17,26 @@ import java.util.Date;
  */
 @Data
 public class IpAccountVO implements Serializable,Cloneable{
-    /** 主键,; */
+    @Schema(description = "主键")
     private Long id ;
-    /** 账户编号,; */
+    @Schema(description = "账户编号")
     private String accNo ;
-    /** 备注,; */
+    @Schema(description = "备注")
     private String remark ;
-    /** 状态,normal 有效,disable 禁用,delete 删除,; */
+    @Schema(description = "状态,normal 有效,disable 禁用,delete 删除")
     private String status ;
-    /** 创建时间,; */
+    @Schema(description = "创建时间")
     @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
     private LocalDateTime addTime ;
-    /** 更新时间,; */
+    @Schema(description = "更新时间")
     @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
     private LocalDateTime updateTime ;
-    /** 创建人id,; */
+    @Schema(description = "创建人id")
     private Long addUserId ;
-    /** 更新人id,; */
+    @Schema(description = "更新人id")
     private Long updateUserId ;
-    /** 创建人姓名,; */
+    @Schema(description = "创建人姓名")
     private String addUserName ;
-    /** 更新人姓名,; */
+    @Schema(description = "更新人姓名")
     private String updateUserName ;
 }

+ 13 - 12
src/main/java/com/hr/vo/IpInterfaceVO.java

@@ -1,6 +1,7 @@
 package com.hr.vo;
 
 import com.fasterxml.jackson.annotation.JsonFormat;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 import java.io.Serializable;
@@ -14,32 +15,32 @@ import java.time.LocalDateTime;
 @Data
 public class IpInterfaceVO implements Serializable,Cloneable{
 
-    /** 主键,; */
+    @Schema(description = "主键")
     private Long id ;
-    /** 接口名称,名称唯一,; */
+    @Schema(description = "接口名称,名称唯一")
     private String interfaceName ;
     private String interfaceNo;
-    /** 接口厂商,; */
+    @Schema(description = "接口厂商")
     private String manufacturer ;
-    /** 备注,; */
+    @Schema(description = "备注")
     private String remark ;
-    /** 状态,normal 有效,disable 禁用,delete 删除,; */
+    @Schema(description = "状态,normal 有效,disable 禁用,delete 删除")
     private String status ;
-    /** 接口配置,JSON格式的配置文件,存放接口参数,; */
+    @Schema(description = "接口配置,JSON格式的配置文件,存放接口参数")
     private String interfaceConfig ;
-    /** 创建时间,; */
+    @Schema(description = "创建时间")
     @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
     private LocalDateTime addTime ;
-    /** 更新时间,; */
+    @Schema(description = "更新时间")
     @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
     private LocalDateTime updateTime ;
-    /** 创建人id,; */
+    @Schema(description = "创建人id")
     private Long addUserId ;
-    /** 更新人id,; */
+    @Schema(description = "更新人id")
     private Long updateUserId ;
-    /** 创建人姓名,; */
+    @Schema(description = "创建人姓名")
     private String addUserName ;
-    /** 更新人姓名,; */
+    @Schema(description = "更新人姓名")
     private String updateUserName ;
 
 }

+ 17 - 16
src/main/java/com/hr/vo/IpLogVO.java

@@ -1,5 +1,6 @@
 package com.hr.vo;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.persistence.Entity;
 import jakarta.persistence.Id;
 import lombok.Data;
@@ -15,37 +16,37 @@ import java.time.LocalDateTime;
 @Data
 public class IpLogVO implements Serializable,Cloneable{
 
-    /** 主键,; */
+    @Schema(description = "主键")
     private Long id ;
-    /** 调用记录表主键,; */
+    @Schema(description = "调用记录表主键")
     private String oid ;
-    /** 调用编号(业务编号),唯一,格式为年月日时分秒毫秒加6位随机数 20250918010256001000001,; */
+    @Schema(description = "调用编号(业务编号),唯一,格式为年月日时分秒毫秒加6位随机数 20250918010256001000001")
     private String orderNo ;
-    /** 执行类型,request请求,callback回调,; */
+    @Schema(description = "执行类型,request请求,callback回调")
     private String executeType ;
-    /** 请求地址/回调地址,如果是请求类型则记录请求地址。若是回调类型则记录回调地址。,; */
+    @Schema(description = "请求地址/回调地址,如果是请求类型则记录请求地址。若是回调类型则记录回调地址。")
     private String url ;
-    /** 请求状态,handle处理中,success成功,fail失败,; */
+    @Schema(description = "请求状态,handle处理中,success成功,fail失败")
     private String status ;
-    /** 请求参数,临时存储json格式,通过定时任务上传到OSS后更换为oss存储url,; */
+    @Schema(description = "请求参数,临时存储json格式,通过定时任务上传到OSS后更换为oss存储url")
     private String requestParam ;
-    /** 响应结果,临时存储json格式,通过定时任务上传到OSS后更换为oss存储url,; */
+    @Schema(description = "响应结果,临时存储json格式,通过定时任务上传到OSS后更换为oss存储url")
     private String responseResult ;
-    /** 响应状态码,; */
+    @Schema(description = "响应状态码")
     private String httpStatus ;
-    /** 异常信息,存储调用时的各种程序异常信息,; */
+    @Schema(description = "异常信息,存储调用时的各种程序异常信息")
     private String msg ;
-    /** 创建时间,; */
+    @Schema(description = "创建时间")
     private LocalDateTime addTime ;
-    /** 更新时间,; */
+    @Schema(description = "更新时间")
     private LocalDateTime updateTime ;
-    /** 创建人id,; */
+    @Schema(description = "创建人id")
     private String addUserId ;
-    /** 更新人id,; */
+    @Schema(description = "更新人id")
     private String updateUserId ;
-    /** 创建人姓名,; */
+    @Schema(description = "创建人姓名")
     private String addUserName ;
-    /** 更新人姓名,; */
+    @Schema(description = "更新人姓名")
     private String updateUserName ;
     
 }

+ 20 - 52
src/main/java/com/hr/vo/IpOrderVO.java

@@ -1,5 +1,6 @@
 package com.hr.vo;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.persistence.Entity;
 import jakarta.persistence.Id;
 import lombok.Data;
@@ -8,76 +9,43 @@ import java.io.Serializable;
 import java.time.LocalDateTime;
 
 /**
- * 调用记录表;IpOrder数据表的PO对象
- *
- * @author : longhoo
- * @date : 2025-10-10
+ * * 调用记录表;IpOrder数据表的PO对象
+ * *
  */
 @Data
 public class IpOrderVO implements Serializable, Cloneable {
 
-    /**
-     * 主键,;
-     */
+
+    @Schema(description = "主键")
     private Long id;
-    /**
-     * 调用编号(业务编号),唯一,格式为年月日时分秒毫秒加6位随机数20250918010256001000001,;
-     */
+    @Schema(description = "调用编号(业务编号),唯一,格式为年月日时分秒毫秒加6位随机数20250918010256001000001")
     private String orderNo;
-    /**
-     * 接口名称,;
-     */
+    @Schema(description = "接口名称")
     private String interfaceName;
-    /**
-     * 账户编号,;
-     */
+    @Schema(description = "账户编号")
     private String accNo;
-    /**
-     * token值,;
-     */
+    @Schema(description = "token值")
     private String token;
-    /**
-     * 回调地址,;
-     */
+    @Schema(description = "回调地址")
     private String callbackUrl;
-    /**
-     * 是否支持回调,yes支持,no不支持,;
-     */
+    @Schema(description = "是否支持回调,yes支持,no不支持")
     private String isCallback;
-    /**
-     * 回调次数,尝试回调的次数,超过次数则不再回调,;
-     */
+    @Schema(description = "回调次数,尝试回调的次数,超过次数则不再回调")
     private int callbackNum;
-    /**
-     * 调用状态,handle处理中,success成功,fail失败,;
-     */
+    @Schema(description = "调用状态,handle处理中,success成功,fail失败")
     private String orderStatus;
-    /**
-     * 回调状态,handle处理中,success成功,fail失败,;
-     */
+    @Schema(description = "回调状态,handle处理中,success成功,fail失败")
     private String callbackStatus;
-    /**
-     * 创建时间,;
-     */
+    @Schema(description = "创建时间")
     private LocalDateTime addTime;
-    /**
-     * 更新时间,;
-     */
+    @Schema(description = "更新时间")
     private LocalDateTime updateTime;
-    /**
-     * 创建人id,;
-     */
+    @Schema(description = "创建人id")
     private String addUserId;
-    /**
-     * 更新人id,;
-     */
+    @Schema(description = "更新人id")
     private String updateUserId;
-    /**
-     * 创建人姓名,;
-     */
+    @Schema(description = "创建人姓名")
     private String addUserName;
-    /**
-     * 更新人姓名,;
-     */
+    @Schema(description = "更新人姓名")
     private String updateUserName;
 }

+ 13 - 12
src/main/java/com/hr/vo/IpTokenInterfaceVO.java

@@ -1,5 +1,6 @@
 package com.hr.vo;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 import java.io.Serializable;
@@ -13,28 +14,28 @@ import java.time.LocalDateTime;
  
 @Data
 public class IpTokenInterfaceVO implements Serializable,Cloneable{
-    /** 主键,; */
+    @Schema(description = "主键")
     private Long id ;
-    /** token表主键,; */
+    @Schema(description = "token表主键")
     private String tid ;
-    /** 接口表主键,; */
+    @Schema(description = "接口表主键")
     private String iid ;
-    /** 是否支持回调,yes支持,no不支持,; */
+    @Schema(description = "是否支持回调,yes支持,no不支持")
     private String isCallback ;
-    /** 回调地址(回调url),回调的url,只有在支持回调时才有,; */
+    @Schema(description = "回调地址(回调url),回调的url,只有在支持回调时才有")
     private String callbackUrl ;
-    /** 回调次数,尝试回调的次数,超过次数则不再回调,; */
+    @Schema(description = "回调次数,尝试回调的次数,超过次数则不再回调")
     private int callbackNum ;
-    /** 创建时间,; */
+    @Schema(description = "创建时间")
     private LocalDateTime addTime ;
-    /** 更新时间,; */
+    @Schema(description = "更新时间")
     private LocalDateTime updateTime ;
-    /** 创建人id,; */
+    @Schema(description = "创建人id")
     private String addUserId ;
-    /** 更新人id,; */
+    @Schema(description = "更新人id")
     private String updateUserId ;
-    /** 创建人姓名,; */
+    @Schema(description = "创建人姓名")
     private String addUserName ;
-    /** 更新人姓名,; */
+    @Schema(description = "更新人姓名")
     private String updateUserName ;
 }

+ 13 - 12
src/main/java/com/hr/vo/IpTokenVO.java

@@ -1,5 +1,6 @@
 package com.hr.vo;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 import java.io.Serializable;
@@ -13,28 +14,28 @@ import java.time.LocalDateTime;
  
 @Data
 public class IpTokenVO implements Serializable,Cloneable{
-    /** 主键,; */
+    @Schema(description = "主键")
     private Long id ;
-    /** 账户表主键,; */
+    @Schema(description = "账户表主键")
     private Long aid ;
-    /** token值,; */
+    @Schema(description = "token值")
     private String token ;
-    /** 密钥值,; */
+    @Schema(description = "密钥值")
     private String secret ;
-    /** 备注,; */
+    @Schema(description = "备注")
     private String remark ;
-    /** 状态,normal 有效,disable 禁用,delete 删除,; */
+    @Schema(description = "状态,normal 有效,disable 禁用,delete 删除")
     private String tokenStatus ;
-    /** 创建时间,; */
+    @Schema(description = "创建时间")
     private LocalDateTime addTime ;
-    /** 更新时间,; */
+    @Schema(description = "更新时间")
     private LocalDateTime updateTime ;
-    /** 创建人id,; */
+    @Schema(description = "创建人id")
     private String addUserId ;
-    /** 更新人id,; */
+    @Schema(description = "更新人id")
     private String updateUserId ;
-    /** 创建人姓名,; */
+    @Schema(description = "创建人姓名")
     private String addUserName ;
-    /** 更新人姓名,; */
+    @Schema(description = "更新人姓名")
     private String updateUserName ;
 }