cn.easyutil.easyapi.interview.controller

类 ApiDocController

java.lang.Object

cn.easyutil.easyapi.interview.controller.ApiDocController

@ApidocComment(ignore=true)
 @RestController
 @RequestMapping(value="/easyapi/doc")
public class ApiDocController
extends Object

接口文档接口

作者:

spc

构造器概要

构造器

构造器和说明
ApiDocController()

方法概要

限定符和类型	方法和说明
ResponseBody	addInterfaces(String json, Long projectId) 添加一个接口 控制器名称
ResponseBody	delInterfaces(String controllerName, String requestUrl, Long projectId, Long interfaceId) 删除接口
ResponseBody	doUrl(javax.servlet.http.HttpServletRequest request, HttpEntity enty) 网络请求
void	downHtml(javax.servlet.http.HttpServletResponse response, Long projectId)
ResponseBody	exportApiExcel() 导出接口文档到excel
ResponseBody	exportTestExcel() 导出测试用例
ResponseBody	findInterfaces(String text, Long projectId)
ResponseBody	getControllers(Long projectId) 获取控制器列表
ResponseBody	getInfo(Long projectId) 获取接口文档说明
ResponseBody	getInterfaces(String controllerName, Long controllerId, Long projectId) 获取接口列表
ResponseBody	getMockData(String responseParamName, Long projectId, Long interfaceId) 获取mock数据
ResponseBody	getOutPackage(Long projectId) 获取返回数据外包装
ResponseBody	getRequestParam(String requestParamName, Long interfaceId, Long projectId) 获取请求参数
ResponseBody	getResponseParam(String responseParamName, Long interfaceId, Long projectId) 获取响应参数
ResponseBody	importRequestParam() 导入请求参数
ResponseBody	importResponseParam() 导入返回参数
ResponseBody	manualSync(String controllerName, String interfaceName, String address) 同步单个接口
ResponseBody	manualSyncAll(String address, String username, String password) 手动同步到目标服务器
Object	mockResponse(String path, Long projectId, Long interfaceId) 获取响应的mock数据 例：http://localhost:8089/yifei-apidoc/mock?
void	receiveSyncAll(SyncRemoteAll remoteAll) 接收外来的同步文件请求
void	receiveSyncInterface(SyncRemoteInterface remoteInterface)
void	updateChildrenShow(Map m) 修改接口参数时如果父类设置隐藏，则子类一并隐藏
ResponseBody	updateInfo(InfoBean info, Long projectId) 修改项目介绍
ResponseBody	updateInteface(String controllerName, String javaName, String json, Long projectId, Long interfaceId) 修改接口详情
ResponseBody	updateMock(String responseParamName, String json, Long interfaceId, Long projectId) 修改mock数据
ResponseBody	updateOutPackage(String json, Long projectId) 修改返回数据外包装
ResponseBody	updateRequestParams(UpdateReqOrResParamDto dto) 修改入参
ResponseBody	updateResponseParams(UpdateReqOrResParamDto dto) 修改返回值
void	updateShow(Map map) 修改接口参数时如果父类设置隐藏，则子类一并隐藏

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ApiDocController

public ApiDocController()

方法详细资料

downHtml

@RequestMapping(value="/downJS")
public void downHtml(javax.servlet.http.HttpServletResponse response,
                                                       Long projectId)
                                                throws Exception

抛出:

Exception

manualSync

@PostMapping(value="/manualSync")
public ResponseBody manualSync(String controllerName,
                                                                  String interfaceName,
                                                                  String address)

同步单个接口

参数:

controllerName - 控制器名称

interfaceName - 接口名称

address - 同步地址

返回:

manualSyncAll

@PostMapping(value="/manualSyncAll")
public ResponseBody manualSyncAll(String address,
                                                                        String username,
                                                                        String password)

手动同步到目标服务器

参数:

address - 目标服务器

username - 账户名

password - 密码

receiveSyncAll

@PostMapping(value="/receiveSyncAll")
public void receiveSyncAll(SyncRemoteAll remoteAll)

接收外来的同步文件请求

参数:

remoteAll -

receiveSyncInterface

@PostMapping(value="/receiveSyncInterface")
public void receiveSyncInterface(SyncRemoteInterface remoteInterface)

getInfo

@PostMapping(value="/getInfo")
public ResponseBody getInfo(Long projectId)

获取接口文档说明

返回:

getOutPackage

@PostMapping(value="/getOutPackage")
public ResponseBody getOutPackage(Long projectId)

获取返回数据外包装

返回:

updateOutPackage

@PostMapping(value="/updateOutPackage")
public ResponseBody updateOutPackage(String json,
                                                                              Long projectId)

修改返回数据外包装

返回:

getControllers

@PostMapping(value="/getControllers")
public ResponseBody getControllers(Long projectId)

获取控制器列表

返回:

findInterfaces

@PostMapping(value="/findInterfaces")
public ResponseBody findInterfaces(String text,
                                                                          Long projectId)

参数:

text -

返回:

mockResponse

@RequestMapping(value="/mock")
public Object mockResponse(String path,
                                                           Long projectId,
                                                           Long interfaceId)

获取响应的mock数据 例：http://localhost:8089/yifei-apidoc/mock?path=apis/s-10001

参数:

path -

返回:

getMockData

@PostMapping(value="/getMock")
public ResponseBody getMockData(String responseParamName,
                                                                Long projectId,
                                                                Long interfaceId)

获取mock数据

参数:

responseParamName -

返回:

updateMock

@PostMapping(value="/updateMock")
public ResponseBody updateMock(String responseParamName,
                                                                  String json,
                                                                  Long interfaceId,
                                                                  Long projectId)

修改mock数据

参数:

responseParamName - 返回值名称

json - 更新的数据

返回:

getInterfaces

@PostMapping(value="/getInterfaces")
public ResponseBody getInterfaces(String controllerName,
                                                                        Long controllerId,
                                                                        Long projectId)

获取接口列表

参数:

controllerName - 控制器名称

controllerId - 控制器id

返回:

addInterfaces

@PostMapping(value="/addInterfaces")
public ResponseBody addInterfaces(String json,
                                                                        Long projectId)

添加一个接口

控制器名称

参数:

json - 接口信息

返回:

delInterfaces

@PostMapping(value="/delInterfaces")
public ResponseBody delInterfaces(String controllerName,
                                                                        String requestUrl,
                                                                        Long projectId,
                                                                        Long interfaceId)

删除接口

参数:

controllerName - 控制器名字

requestUrl - 接口路径

返回:

getRequestParam

@PostMapping(value="/getRequestParam")
public ResponseBody getRequestParam(String requestParamName,
                                                                            Long interfaceId,
                                                                            Long projectId)

获取请求参数

返回:

getResponseParam

@PostMapping(value="/getResponseParam")
public ResponseBody getResponseParam(String responseParamName,
                                                                              Long interfaceId,
                                                                              Long projectId)

获取响应参数

返回:

doUrl

@PostMapping(value="/doUrl")
public ResponseBody doUrl(javax.servlet.http.HttpServletRequest request,
                                                        HttpEntity enty)

网络请求

参数:

enty -

返回:

updateInfo

@PostMapping(value="/updateInfo")
public ResponseBody updateInfo(InfoBean info,
                                                                  Long projectId)

修改项目介绍

参数:

info -

updateRequestParams

@PostMapping(value="/updateRequestParams")
public ResponseBody updateRequestParams(UpdateReqOrResParamDto dto)

修改入参

参数:

dto -

updateResponseParams

@PostMapping(value="/updateResponseParams")
public ResponseBody updateResponseParams(UpdateReqOrResParamDto dto)

修改返回值

参数:

dto -

updateInteface

@PostMapping(value="/updateInteface")
public ResponseBody updateInteface(String controllerName,
                                                                          String javaName,
                                                                          String json,
                                                                          Long projectId,
                                                                          Long interfaceId)

修改接口详情

参数:

controllerName - 控制器名称

json - 接口详情json

返回:

importRequestParam

@PostMapping(value="/importRequestParam")
public ResponseBody importRequestParam()

导入请求参数

importResponseParam

@PostMapping(value="/importResponseParam")
public ResponseBody importResponseParam()

导入返回参数

exportTestExcel

@PostMapping(value="/exportTestExcel")
public ResponseBody exportTestExcel()

导出测试用例

exportApiExcel

@PostMapping(value="/exportApiExcel")
public ResponseBody exportApiExcel()

导出接口文档到excel

updateChildrenShow

public void updateChildrenShow(Map m)

修改接口参数时如果父类设置隐藏，则子类一并隐藏

参数:

m -

updateShow

public void updateShow(Map map)

修改接口参数时如果父类设置隐藏，则子类一并隐藏

参数:

map -