Apidev 1.0.3 首次上线发布
APIDev是一个专注于API开发和管理的平台，旨在为开发者提供高效的API解决方案和工具。
无论你是经验丰富的资深开发者，还是初涉 API 领域的新手，APIDev 都能成为你不可或缺的得力助手，助力你在 API 开发与管理的道路上一路驰骋。
一、安装
1、Maven 依赖
在项目中的pom.xml文件添加以下Maven坐标：
<dependency> <groupId>cn.apidev</groupId> <artifactId>apidev</artifactId> <version>1.0.3</version> </dependency>
2、创建数据库表：apidev_api
MySQL：
CREATE TABLE `apidev_api` ( `id` varchar(64) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT '主键', `action_key` varchar(500) CHARACTER SET utf8 DEFAULT NULL COMMENT '接口路径', `description` varchar(255) CHARACTER SET utf8 DEFAULT NULL COMMENT '接口描述', `controller` varchar(255) CHARACTER SET utf8 DEFAULT NULL COMMENT '控制器', `remark` varchar(255) CHARACTER SET utf8 DEFAULT NULL COMMENT '备注', `title` varchar(255) CHARACTER SET utf8 DEFAULT NULL COMMENT '接口标题', `request_url` varchar(500) CHARACTER SET utf8 DEFAULT NULL COMMENT '请求路径', `request_mode` varchar(50) CHARACTER SET utf8 DEFAULT NULL COMMENT '请求方式', `request_headers` varchar(2000) CHARACTER SET utf8 DEFAULT NULL COMMENT '请求Headers参数', `request_body_type` varchar(50) CHARACTER SET utf8 DEFAULT NULL COMMENT '请求的bodyType类型', `request_param` varchar(2000) CHARACTER SET utf8 DEFAULT NULL COMMENT '请求query参数', `request_param_explain` longtext CHARACTER SET utf8 COMMENT '请求query参数说明', `request_path_explain` longtext CHARACTER SET utf8 COMMENT '请求Path参数说明', `request_result` longtext CHARACTER SET utf8 COMMENT '请求结果，保存最新记录', `request_body` longtext CHARACTER SET utf8 COMMENT '请求body参数', `request_body_explain` longtext CHARACTER SET utf8 COMMENT '请求body参数说明', `request_form_data` longtext CHARACTER SET utf8 COMMENT '请求form-data的参数', `success_demo` longtext CHARACTER SET utf8 COMMENT '请求成功返回示例', `success_demo_explain` longtext CHARACTER SET utf8 COMMENT '请求成功返回示例参数说明', `failuer_demo` longtext CHARACTER SET utf8 COMMENT '请求失败返回示例', `failuer_demo_explain` longtext CHARACTER SET utf8 COMMENT '请求失败返回示例参数说明', `request_remark` varchar(255) CHARACTER SET utf8 DEFAULT NULL COMMENT '请求接口文档备注', `interface_status` varchar(50) CHARACTER SET utf8 DEFAULT NULL COMMENT '接口状态', `response_headers` longtext CHARACTER SET utf8 COMMENT '响应头', `response_definition` longtext CHARACTER SET utf8 COMMENT '响应定义', `response_demo` longtext CHARACTER SET utf8 COMMENT '响应用例', `sort` int NULL DEFAULT 1 COMMENT '排序', `create_by` varchar(100) CHARACTER SET utf8 DEFAULT NULL COMMENT '创建人', `create_time` datetime NULL DEFAULT NULL COMMENT '创建时间', `update_by` varchar(100) CHARACTER SET utf8 DEFAULT NULL COMMENT '修改人', `update_time` datetime NULL DEFAULT NULL COMMENT '最新修改时间', `type` varchar(255) CHARACTER SET utf8 DEFAULT NULL COMMENT 'menu:目录，api:接口，demo：用例，link：快捷请求', `parent_id` varchar(64) CHARACTER SET utf8 DEFAULT '-1' COMMENT '父级id（1:是接口根目录，2：是快捷请求根目录）', `del` int NULL DEFAULT 0 COMMENT '0：恢复正常状态，1：标记已删除，显示在回收站，2：标记下级数据被删除，不显示回收站', `visible` int NULL DEFAULT 1 COMMENT '接口是否可见(0:不可见，1：可见)', `share_id` varchar(255) CHARACTER SET utf8 DEFAULT NULL COMMENT '分享id', `password` varchar(100) CHARACTER SET utf8 DEFAULT NULL COMMENT '访问密码', `expiret_time` date NULL DEFAULT NULL COMMENT '访问过期时间', PRIMARY KEY (`id`) USING BTREE ) ENGINE = InnoDB CHARACTER SET = utf8 COMMENT = 'Apidev接口' ROW_FORMAT = DYNAMIC;
二、其他安装步骤
JFinal项目配置步骤，在JFinalConfig主配置类的对应方法配置代码如下：
1、配置APIDev路由：
public void configRoute(Routes me) {
...
// 添加Apidev前端路由
ApidevKit.configRoute(me);
}
2、配置APIDev模板引擎：
public void configEngine(Engine me) {
// 配置APIDev模板资源目录,这行代码必须放在方法的最前面
ApidevKit.configEngine(me);
...
}
3、onStart打印APIDev信息：
public void onStart() {
// 打印APIDev配置想信息
ApidevKit.onStart();
}
4、在undertow.txt添加以下配置项：
#处理类转换异常问题 undertow.hotSwapClassPrefix=cn.apidev #配置jar的资源目录 undertow.resourcePath = src/main/webapp,classpath:webapp
5、将您自己项目的前端文件由原来的src/main/webapp目录转移到src/main/resource目录下面，文件夹名称为webapp:
src/main/resources -webapp
6、在项目数据库创建数据库表：apidev_api
7、可选配置项：在您项目的配置文件加上下面配置项即可：
#1、Apidev 路由配置，默认是/apidev apidev.actionKey=/apidev #2、生产环境可以关闭apidev服务 apidev.stop=true
8、启动项目: APIDev启动成功会打印出如下信息,访问路由：http://{项目地址}/apidev
APIDev Server Info: > Start: true > Version: 1.0.3 > ActionKey: /apidev
SpringBoot项目配置步骤：
1、 在启动类加上扫描目录：cn.apidev，Demo如下：
@SpringBootApplication(scanBasePackages = {"com.qinhailin", "cn.apidev"})
@EnableTransactionManagement
@EnableScheduling
@Slf4j
public class ApidevApplication extends SpringBootServletInitializer {
public static void main(String[] args) {
try {
SpringApplication.run(ApidevApplication.class, args);
} catch (Throwable throwable) {
log.error("系统异常关闭", throwable);
}
}
}
2、yml配置数据库信息：spring.datasource.url,spring.datasource.username,spring.datasource.password
spring: datasource: url: jdbc:mysql://localhost:3306/apidev username: root password: root
3、正常启动SpringBoot项目，APIDev启动成功会打印出如下信息,访问路由：http://{项目地址}/apidev
APIDev Server Info: > Start: true > Version: 1.0.3 > ActionKey: /apidev
4、可选配置项：需要在src/main/resource目录下创建apidev-config.txt文件，然后添加如下配置项：
#1、Apidev 路由配置，默认是/apidev apidev.actionKey=/apidev #2、生产环境可以关闭apidev服务 apidev.stop=true
三、界面效果图
1、APIDev管理首页,默认地址：http://localhost/apidev/
暗黑主题
明亮主题
2、同步接口
3、目录管理页
目录接口管理页
新增目录
目录分享设置
4、接口管理页
接口调试界面
目录树功能菜单
响应示例
接口文档
接口说明信息
5、分享链接
复制链接
分享地址界面
导出文档
6、回收站
