API列表

最近更新时间:2020-08-06 15:14:51

操作场景
KMSE提供API列表功能,采用的是swagger2,用户可在控制台查看以及调用API列表。

前提条件
向工程中添加依赖,在pom.xml中添加以下依赖:

<dependency>
  <groupId>com.ksyun.kmse</groupId>
  <artifactId>spring-cloud-kmse-swagger</artifactId>
  <version>${version}</version>
</dependency>

操作步骤

  1. 给controller添加注解

常用注解

注解 示例 属性 备注
@Api @Api(value = "xxx", description = "xxx") value 字符串 可用在class头上,class描述
description 字符串 -
@ApiOperation @ApiOperation(value = "xxx", notes = "xxx") value 字符串 可用在方法头上.参数的描述容器
notes 字符串 -
@ApiImplicitParams @ApiImplicitParams({@ApiImplicitParam{...},@ApiImplicitParam{...},...}) {} @ApiImplicitParam数组 可用在方法头上.参数的描述容器
@ApiImplicitParam @ApiImplicitParam(name = "xxx", value = "xxx", required = true, dataType = "xxx", paramType = "xxx", defaultValue = "xxx") name 字符串与参数命名对应 可用在@ApiImplicitParams里
value 字符串 参数中文描述
required 布尔值 true/false
dataType 字符串 参数类型
paramType 字符串 参数请求方式:query/path
defaultValue 字符串 在api测试中默认值
@ApiResponses @ApiResponses({@ApiResponse{...},@ApiResponse{...},...}) {} @ApiResponse数组 可用在方法头上.参数的描述容器
@ApiResponse @ApiResponse(code = 200, message = "Successful") code 整型 可用在@ApiResponses里
message 字符串 错误描述

代码示例

@RequestMapping({"/account"})
@RestController
@Api(value = "API - AccountController")
public class AccountController {

    private static final Logger log = LoggerFactory.getLogger(AccountController.class);

    public AccountController() {
    }

    @ApiOperation(value = "查询用户接口", notes="此接口用户查询用户信息", response= String.class)
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "用户ID", required = true,
                    dataType = "string", paramType = "path", defaultValue = "1"),
    })
    @ApiResponses(value = {
            @ApiResponse(code = 200, message = "Successful — 请求已完成"),
            @ApiResponse(code = 400, message = "请求中有语法问题,或不能满足请求"),
            @ApiResponse(code = 401, message = "未授权客户机访问数据"),
            @ApiResponse(code = 404, message = "服务器找不到给定的资源;文档不存在"),
            @ApiResponse(code = 500, message = "服务器不能完成请求")}
    )
    @GetMapping({"/{id}"})
    public String account(@PathVariable("id") Integer id) {
        log.info("调用account " + id);
        return id + "";
    }
}
  1. 启动服务
    访问本地服务:http://localhost:8080/swagger-ui.html

API列表

  1. 将应用上传至KMSE控制台。

API列表

  1. 控制台调试。

API列表

金山云,开启您的云计算之旅

免费注册