使用Swagger自动生成文档

以你之姓@ 2022-05-10 06:00 332阅读 0赞

> swagger 自动生成html文档  
> 使用 wireMock快速伪造Restful服务

## pom.xml ##

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

## 主方法上加入 ##

@SpringBootApplication
    @EnableSwagger2
    public class DemoApplication {

## 访问 ##

> [http://localhost:8060/swagger-ui.html][http_localhost_8060_swagger-ui.html]

## 属性 ##

### controller ###

@GetMapping
        @JsonView(User.UserSimpleView.class)
        @ApiOperation(value = "用户查询服务")
        public List<User> query(UserQueryCondition condition,

public User getInfo(@ApiParam("用户id") @PathVariable String id) {

### 参数model ###

public class UserQueryCondition {
    	@ApiModelProperty(value = "用户年龄起始值")
    	private int age;

## wiremock 伪造请求 ##

> 下载运行 java -jar wiremock-standalone-2.19.0.jar --port

<dependency>
    			<groupId>com.github.tomakehurst</groupId>
    			<artifactId>wiremock</artifactId>
    		</dependency>

### main ###

静态类 WireMock
    	public static void main(String[] args) throws IOException {
    		configureFor(8062);
    		removeAllMappings();
    		mock("/order/1", "01");
    		mock("/order/2", "02");
    	}
    	//文件的内容如下
    	{
    	"id":1,
    	"type":"C"
        }
    
    	private static void mock(String url, String file) throws IOException {
    		ClassPathResource resource = new ClassPathResource("mock/response/" + file + ".txt");
    		String content = StringUtils.join(FileUtils.readLines(resource.getFile(), "UTF-8").toArray(), "\n");
    		stubFor(get(urlPathEqualTo(url)).willReturn(aResponse().withBody(content).withStatus(200)));
    	} //WireMock

[http_localhost_8060_swagger-ui.html]: http://localhost:8060/swagger-ui.html