使用swagger进行接口设计,测试和联调

1. swagger简介

swagger是一款能够进行接口设计,测试和联调的开源的OAS(the OpenAPI Specification)。其github

2. 安装swagger-editer

.1 打开swagger-editer,直接进行下载:

使用swagger进行接口设计,测试和联调_第1张图片

.2. 我假设你已经安装好node,npm,并且是合适的版本。
执行下面的命令,安装依赖,
npm install --registry=https://registry.npm.taobao.org·
.3. 打开本地服务
执行下面的命令:
npm run serve-static
如下:

使用swagger进行接口设计,测试和联调_第2张图片

我们便可以愉快的写YAML了。有很多图形化编辑工具,可以百度。
.4. 生成json,备用

使用swagger进行接口设计,测试和联调_第3张图片

2. 安装swagger-codegen

  • 1 . 下载swagger-codegen
    从http://central.maven.org/maven2/io/swagger/swagger-codegen-cli/2.2.2/swagger-codegen-cli-2.2.2.jar 下载类包到本地

  • 2 . 假设你已经安装好jdk8并配置好环境变量了。
    使用命令进行生成
    java -jar swagger-codegen-cli-2.2.2.jar generate -i swagger.json -l spring -o H:\spring
    -jar 指定 swagger-codegen-cli-2.2.2.jar 的位置,绝对路径、相对路径均可;
    -i 指定 swagger.json 的位置,本地路径、网络路径均可;
    -l 指定客户端代码的语言;
    -o 指定代码生成的位置;
    --model-package 指定model代码的包名;
    --api-package 指定api代码的包名;
    于是我们的接口工程便新鲜出炉了:

使用swagger进行接口设计,测试和联调_第4张图片
  • 3 .让程序跑起来。
    执行mvn install 安装spring依赖,用idea打开,进行后续的开发

3.安装swagger-ui

    1. 下载githubswagger-ui中的dist拷贝到刚刚生成的目录resources下:
使用swagger进行接口设计,测试和联调_第5张图片
  • 2 . 修改pom文件
    在pom中添加下面的依赖,注意需要修改版本到自己支持的
 
            io.springfox
            springfox-swagger-ui
            2.2.2
        
        
            io.springfox
            springfox-swagger2
            2.2.2
        

使用swagger进行接口设计,测试和联调_第6张图片

最终启动后访问:
http://127.0.0.1:8080/swagger-ui.html
便可以看到:

使用swagger进行接口设计,测试和联调_第7张图片
借用[小莫](https://xiaomo.info/)的图片

于是我们就可以测试自己的接口

你可能感兴趣的:(使用swagger进行接口设计,测试和联调)