cn.morethank.open.admin.system.controller

类 ApiInterfaceController

java.lang.Object

cn.morethank.open.admin.system.controller.ApiInterfaceController

@RestController
 @RequestMapping(value="/system/api/interface")
public class ApiInterfaceController
extends Object

API接口文档 前端控制器

从以下版本开始:

2023-02-20 09:19:22

作者:

morethank

构造器概要

构造器

构造器和说明
ApiInterfaceController()

方法概要

限定符和类型	方法和说明
Result	add(com.alibaba.fastjson2.JSONObject jsonObject) 新增保存
Result<ApiInterface>	detail(Long id) 详情页
Result	edit(com.alibaba.fastjson2.JSONObject jsonObject) 修改保存
void	export(javax.servlet.http.HttpServletResponse response, ApiInterface apiInterface) 导出接口
Result	getInterface(Long projectId, Long id) 详情页, 编辑页面需要调用详情接口
Result<com.baomidou.mybatisplus.core.metadata.IPage<ApiInterface>>	list(ApiInterface apiInterface, Integer pageNo, Integer pageSize) 分页查询
Result	remove(Long[] ids) 删除接口
Result	sync(ApiInterface apiInterface) 同步接口 即从java代码中解析接口，并同步到接口表中

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

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

构造器详细资料

ApiInterfaceController

public ApiInterfaceController()

方法详细资料

getInterface

@OperateLog(title="\u63a5\u53e3\u6587\u6863",
            businessType=DETAIL)
 @PreAuthorize(value="@auth.hasAuthority(\'system:interface:query\')")
 @GetMapping(value={"/{projectId}/","/{projectId}/{id}"})
public Result getInterface(@PathVariable
                                                                                                                                                                                                                                               Long projectId,
                                                                                                                                                                                                                                               @PathVariable(value="id",required=false)
                                                                                                                                                                                                                                               Long id)

详情页, 编辑页面需要调用详情接口

detail

@OperateLog(title="\u63a5\u53e3\u6587\u6863",
            businessType=DETAIL)
 @PreAuthorize(value="@auth.hasAuthority(\'system:interface:query\')")
 @GetMapping(value="/detail")
public Result<ApiInterface> detail(Long id)

详情页

list

@OperateLog(title="\u63a5\u53e3\u6587\u6863",
            businessType=LIST)
 @PreAuthorize(value="@auth.hasAuthority(\'system:interface:list\')")
 @GetMapping(value="/list")
public Result<com.baomidou.mybatisplus.core.metadata.IPage<ApiInterface>> list(ApiInterface apiInterface,
                                                                                                                                                                                                                                                                  @RequestParam(name="pageNum",defaultValue="1")
                                                                                                                                                                                                                                                                  Integer pageNo,
                                                                                                                                                                                                                                                                  @RequestParam(name="pageSize",defaultValue="10")
                                                                                                                                                                                                                                                                  Integer pageSize)

分页查询

参数:

apiInterface - 分页查询筛选条件

pageNo - 页码

pageSize - 每页的数量

返回:

分页查询结果

add

@OperateLog(title="\u63a5\u53e3\u6587\u6863",
            businessType=INSERT)
 @PreAuthorize(value="@auth.hasAuthority(\'system:interface:add\')")
 @PostMapping
public Result add(@Validated @RequestBody
                                                                                                                                                                                        com.alibaba.fastjson2.JSONObject jsonObject)

新增保存

edit

@OperateLog(title="\u63a5\u53e3\u6587\u6863",
            businessType=UPDATE)
 @PreAuthorize(value="@auth.hasAuthority(\'system:interface:edit\')")
 @PutMapping
public Result edit(@Validated @RequestBody
                                                                                                                                                                                         com.alibaba.fastjson2.JSONObject jsonObject)

修改保存

remove

@OperateLog(title="\u63a5\u53e3\u6587\u6863",
            businessType=DELETE)
 @PreAuthorize(value="@auth.hasAuthority(\'system:interface:remove\')")
 @DeleteMapping(value="/{ids}")
public Result remove(@PathVariable
                                                                                                                                                                                                                Long[] ids)

删除接口

export

@OperateLog(title="\u63a5\u53e3\u6587\u6863",
            businessType=EXPORT)
 @PreAuthorize(value="@auth.hasAuthority(\'system:interface:export\')")
 @PostMapping(value="/export")
public void export(javax.servlet.http.HttpServletResponse response,
                                                                                                                                                                                                             ApiInterface apiInterface)
                                                                                                                                                                                                      throws Exception

导出接口

抛出:

Exception

sync

@OperateLog(title="\u63a5\u53e3\u6587\u6863",
            businessType=SYNC)
 @PostMapping(value="sync")
public Result sync(@RequestBody
                                                                                                                               ApiInterface apiInterface)

同步接口 即从java代码中解析接口，并同步到接口表中

参数:

apiInterface -

返回: