zfs-api-administration

项目介绍

api 文档管理系统

使用教程

引入依赖 <dependency> <groupId>cn.zhangfusheng</groupId> <artifactId>zfs-api-administrator-core</artifactId> <version>1.0.2</version> </dependency> 配置包扫描路径以及生成文档接口 @Configuration @ComponentScan("cn.zhangfusheng.api.rest") // API接口的路径,固定写法 public class ZfsApiConfig implements CommandLineRunner { // CommandLineRunner 是spring boot项目提供的预先加载的接口 @Override public void run(String... args) throws Exception { // 初始化接口文档的扫描路径 // 方式一: 扫描一个单独的路径 cn.zhangfusheng.api.config.ZfsApiConfig.initZfsApiConfig("cn.zfs.swagger.ui"); // 方式二: 分组扫描,多个路径 HashMap<String, String> groupPackageMap = new HashMap<>(); groupPackageMap.put("one","cn.zfs.swagger.ui.one.controller"); groupPackageMap.put("two","cn.zfs.swagger.ui.two.controller"); groupPackageMap.put("three","cn.zfs.swagger.ui.three.controller"); cn.zhangfusheng.api.config.ZfsApiConfig.initZfsApiConfig(groupPackageMap); } } 注解使用说明 @ClassAnnotation 描述: 作用于类上的注解,扫描该类下的接口 属性: name string 名称 group string 分组 暂时没用 desc string 描述 hidden Boolean 是否隐藏 path string 请求路径 @MethodAnnotation 描述: 作用于方法的注解,扫描该方法,前提是该方法所属的类上添加了@ClassAnnotation注解 属性: desc string 方法的行为描述 method string 请求方式 hidden Boolean 是否隐藏 path string 请求路径 ParameterAnnotation 请求参数注解 @ParameterAnnotation 描述: 参数列表扫描注解 属性: name string 参数名称 desc string 参数描述 defaultValue string 默认值 type class 参数类型 required Boolean 是否必填 下载客户端并启动 # 从maven仓库下载jar包 https://oss.sonatype.org/service/local/repositories/releases/content/cn/zhangfusheng/zfs-api-administrator-ui/1.0.2/zfs-api-administrator-ui-1.0.2.jar # 从码云上下载客户端 git clone https://gitee.com/fushengruomengzhang_admin/zfs-api-administration.git cd zfs-api-administration mvn clean install cd zfs-api-administrator-ui/target java -jar zfs-api-administrator-ui-1.0.0.jar --server.port=8080 访问API文档 访问: localhost:8080/zfs-api-ui.html 页面的具体使用参考链接 https://blog.csdn.net/qq_33547169/article/details/83275389