快速上手

# 引入依赖

<dependency>
    <groupId>com.charlie.api</groupId>
    <artifactId>cap-client-spring-boot-starter</artifactId>
    <version>0.0.1</version>
</dependency>

1
2
3
4
5

# yaml配置

cap:
  client:
    account: xxx        #平台账户
    accessKey: xxx      #个人密钥
    secretKey: xxx
    ip:                 #接口ip接收list以支持集群部署
      - 127.0.0.1:8080
      - 192.168.1.1:8080

1
2
3
4
5
6
7
8

# 使用注解

ExportApi

使用范围：Method

public @interface ExportApi {   
    /**
     * 相同ip请求间隔 /ms
     */
    int interval() default 0;

    /**
     * 接口备注
     */
    String remark() default "";

    /**
     * 接口自定义请求头 {"xxx=xxx"，"yyy=yyy"}
     */
    String[] headers() default {};
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

ApiParam

适用范围：请求参数

public @interface ApiParam {
    /**
     * 参数说明
     */
    String comment() default "";
}

1
2
3
4
5
6

# 启动服务

启动服务后即可与 server 连接，并在Web界面进行具体配置。 Server 默认 5s 向您的 client 发送心跳，重试次数三次，失败会下线接口。

作者：Charlie 链接：https://gitee.com/Charlie1023/charlie_api_platform

#Profile

详细指南→