测试开发系列之——接口详情（接口预览）功能

api详情页

apiView.html
两个地方都可以进入api详情页：

• 左边接口分类页
• 右边接口列表页

根据api id去DB查询，修改index.html代码，跳转到apiView.html页面。

<!-- 加载此分类下的所有接口 -->
<a href="/lemon/html/apiView.html" target="rightIframe" @click="goTo2(api.id)">

修改apiList.html代码，跳转到apiView.html页面。

function showApi(apiId){
   
	sessionStorage.setItem("apiId",apiId);
}

接口表

api：接口表

• id：主键，自动增长。
• api_classification_id：外键。接口分类id。
• 【核心】name：接口名称。
• method：接口请求方式。
• url：接口路径地址。接口本身的url，调用这个接口的时候，还需要加上基准路径host。
• description：对于接口的简单描述。
• 【外键】create_user：创建者。mybatis-plus自动填充，创建用户就是登录用户。api join user表。
• create_time：创建时间。添加分类的时间。
  

请求参数

queryParam?name=value
headParam

参数表

api_request_param：参数表

• id：主键，自动增长。
• api_id：外键。接口id。api join api_request_param表。
• 【核心】name：参数名。
• param_type：数据性质。数据性质是什么数据类型？
• type：请求参数的类型。1——queryParam，2——bodyParam（application/form），3——headParam，4——bodyParam（application/json）。
• example_data：举例子，给示范。
• description：参数描述。起到提示作用。
• 【外键】create_user：创建者。mybatis-plus自动填充，创建用户就是登录用户。api join user表。
• create_time：创建时间。添加分类的时间。
  

ApiVO.java

在com.one.common下新建类ApiVO.java

package com.one.common;

import java.util.ArrayList;
import java.util.List;

import com.one.pojo.Api;
import com.one.pojo.ApiRequestParam;

import lombok.Data;

@Data
public class ApiVO extends Api {
   
	private String createUsername;
	private String host;
	
	private List<ApiRequestParam> requestParams = new ArrayList<ApiRequestParam>();
	private List<ApiRequestParam> queryParams = new ArrayList<ApiRequestParam>();
	private List<ApiRequestParam> bodyParams = new ArrayList<ApiRequestParam>();
	private List<ApiRequestParam> headerParams = new ArrayList<ApiRequestParam>();
	private List<ApiRequestParam> bodyRawParams = new ArrayList<ApiRequestParam>();
}

SQL

SELECT
	t1.*, t2.username createUsername
FROM
	api t1,
	USER t2
WHERE
	t1.id = 3
AND t1.create_user = t2.id;

ApiMapper.java的代码修改

增加如下代码：

	@Select("SELECT t1.*, t2.username createUsername FROM api t1, USER t2 WHERE t1.id = #{apiId} AND t1.create_user = t2.id")
	public ApiVO findApiViewVO(Integer apiId);

ApiService.java的代码修改

增加如下代码：

public ApiVO findApiViewVO(Integer apiId);

ApiServiceImpl.java的代码修改

增加如下代码：