使用Swagger自动生成文档，wiremock伪造rest服务

╰+攻爆jí腚メ 2022-02-23 03:52 245阅读 0赞

### 文章目录 ###

*  1、使用Swagger自动生成文档
 *   *  加入 swagger 依赖
     *  加注解 启动
     *  swagger注解的使用
     *   *  @ApiOperation 和 @ApiParam
         *  @ApiModelProperty的使用
 *  2、WireMock
 *   *  下载并启动wiremock服务器
     *  加入wiremock依赖
     *  程序中配置wiremock
     *  重构代码

# 1、使用Swagger自动生成文档 #

在前后端分离的项目中，我们的前端和后端都是同时进行的

![在这里插入图片描述][20190406142321103.png]

## 加入 swagger 依赖 ##

首先在 [https://mvnrepository.com][https_mvnrepository.com] 的网站上搜索 springfox  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70]  
第一个是核心包，他是扫面我们的类来生成文档数据的

<dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>

第二个是ui包，生成我们最终看的页面

<dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>

分别把他们加入我的项目demo的pom中

## 加注解 启动 ##

然后再再demo中的DemoApplication启动类上面加上注解`@EnableSwagger2`  
这样就ok了

然后运行项目 访问 [http://localhost:8080/swagger-ui.html][http_localhost_8080_swagger-ui.html] 页面  
这里面列出了我们项目中所有的 controller 和 endpoint

## swagger注解的使用 ##

### @ApiOperation 和 @ApiParam ###

方法的描述用 @ApiOperation  
基本参数的描述使用 @ApiParam  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 1]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 2]

### @ApiModelProperty的使用 ###

如果方法的参数为对象，如何给参数加注解呢  
为此我们需要给这个对象里面的属性加上 `@ApiModelProperty` 注解  
![在这里插入图片描述][20190406145829454.png]  
给参数对象的属性加上下面的注解  
![在这里插入图片描述][20190406145314238.png]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 3]

# 2、WireMock #

当我的后台服务还没有写完的时候，我们就需要伪造服务向前端提供接口  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 4]  
使用WireMock伪造服务，当我们的后台服务开发好后，前端只需要更改一些配置就可以无缝切换

## 下载并启动wiremock服务器 ##

访问 [http://wiremock.org/docs/running-standalone/][http_wiremock.org_docs_running-standalone] 下载jar  
![在这里插入图片描述][20190406152439361.png]  
按照官方文档 启动它 （指定端口并启动日志）

PS D:\wiremock> java -jar wiremock-standalone-2.22.0.jar --port 9999  -verboss

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 5]

## 加入wiremock依赖 ##

[http://wiremock.org/docs/download-and-installation/][http_wiremock.org_docs_download-and-installation]

在demo项目的pom文件中加入依赖、

<dependency>
                <groupId>com.github.tomakehurst</groupId>
                <artifactId>wiremock-jre8-standalone</artifactId>
                <version>2.22.0</version>
                <scope>test</scope>
            </dependency>

官方给的pom没有下载成功，我只好重新引入下面的pom文件

<dependency>
        <groupId>com.github.tomakehurst</groupId>
        <artifactId>wiremock</artifactId>
        <version>2.22.0</version>
        <type>pom</type>
        <scope>test</scope>
    </dependency>

这下依赖加入成功

在后面我写java时需要配置wiremock，却无法引用它的class，最后才发现 这个依赖的 `<scope>test</scope>`  
需要把它的依赖范围改为`<scope>compile</scope>`

## 程序中配置wiremock ##

新建一个类  
![在这里插入图片描述][20190406162750154.png]

/**
     * 它用来连接命令行中启动的服务，告诉服务器怎么处理外界的http请求
     */
    public class MockServe {
    
        public static void main(String[] args) {
    
            //WireMock.configureFor(); 这个方法有很多重载 可以知道ip和端口 因为是本地开发我们不指定ip
            WireMock.configureFor(9999);//指定连接端口
            WireMock.removeAllMappings();    //将之前做过的所有请求配置清掉
    
            //接下来告诉服务器怎么处理请求
            //伪造测试桩
            WireMock.stubFor(
                    WireMock.get(WireMock.urlEqualTo("/order/1"))
                            .willReturn(WireMock.aResponse().withBody("{\"id\":1}").withStatus(200))
            );
        }
    }

右键运行这个main方法

再看wiremock控制台打印的日志  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 6]

然后浏览器访问 [http://localhost:9999/order/1][http_localhost_9999_order_1]  
![在这里插入图片描述][20190406163333440.png]

## 重构代码 ##

/**
     * 它用来连接命令行中启动的服务，告诉服务器怎么处理外界的http请求
     */
    public class MockServe {
    
        public static void main(String[] args) throws IOException {
    
            //WireMock.configureFor(); 这个方法有很多重载 可以知道ip和端口 因为是本地开发我们不指定ip
            WireMock.configureFor(9999);//指定连接端口
            WireMock.removeAllMappings();    //将之前做过的所有请求配置清掉
    
    /**
            ClassPathResource resource = new ClassPathResource("mock/respose/01.txt");
    
            String content = FileUtils.readFileToString(resource.getFile());//将文件里的内容读成string  不推荐了
            content = FileUtils.readFileToString(resource.getFile(), "utf-8"); //也不推荐
    
            List<String> readLines = FileUtils.readLines(resource.getFile(), "utf-8");
            content = StringUtils.join(readLines,"/r");
    
            mock(url,fiel);
    
            //接下来告诉服务器怎么处理请求
            //伪造测试桩
            WireMock.stubFor(
                    WireMock.get(WireMock.urlEqualTo("/order/1"))
                            .willReturn(WireMock.aResponse().withBody("{\"id\":1}").withStatus(200))
            );
    
            // 抽取上面代码为一个方法
    **/
            mock("/order/1","01");
            mock("/order/2","02");
        }
    
        public static void mock(String url,String file) throws IOException {
            ClassPathResource resource = new ClassPathResource("mock/respose/"+file+".txt");
            List<String> readLines = FileUtils.readLines(resource.getFile(), "utf-8");
            //String content = StringUtils.join(readLines.toArray());
            String content = StringUtils.join(readLines.toArray(),"\n");
            WireMock.stubFor(
                    WireMock.get(WireMock.urlEqualTo(url))
                            .willReturn(WireMock.aResponse().withBody(content).withStatus(200))
            );
    
        }
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 7]

浏览器访问测试  
![在这里插入图片描述][2019040617071294.png]

[20190406142321103.png]: /images/20220223/1567e97e816d402f9569344e5696fd05.png
[https_mvnrepository.com]: https://mvnrepository.com
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70]: /images/20220223/cf80dbfbd8a349d492868988d1bd1a78.png
[http_localhost_8080_swagger-ui.html]: http://localhost:8080/swagger-ui.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 1]: /images/20220223/e4d18c00b39d4e27a6632587f9600d65.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 2]: /images/20220223/f6b0ea17374049e1915435b301d70bf0.png
[20190406145829454.png]: /images/20220223/bcb8c931a6034eef881ac2ff830e1f6d.png
[20190406145314238.png]: /images/20220223/0a6ac7bb28bc4e22a772142687737169.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 3]: /images/20220223/c4491c3742364c4a86fd022cca4b1477.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 4]: /images/20220223/8e99079fc1044a5483cd42c612f626e9.png
[http_wiremock.org_docs_running-standalone]: http://wiremock.org/docs/running-standalone/
[20190406152439361.png]: /images/20220223/db404b5c42ec4442bf29cc017c6d0ee2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 5]: /images/20220223/6d8644b4a43146d9abff0ec4aa4ff107.png
[http_wiremock.org_docs_download-and-installation]: http://wiremock.org/docs/download-and-installation/
[20190406162750154.png]: /images/20220223/b1e1559a9ab842849c1c541ffb23b27a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 6]: /images/20220223/7837508db80a4f03bd950af8a121deac.png
[http_localhost_9999_order_1]: http://localhost:9999/order/1
[20190406163333440.png]: /images/20220223/a58332d5f0354bf5b9aa7f9a56fea0b6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 7]: /images/20220223/099be61158154d0fbeff118ed4f5d6f2.png
[2019040617071294.png]: /images/20220223/6d3dc8cbd0cc42b18ca644776a952fc3.png