使用swagger自动生成html文档

前后端分离,便于后台和前台交流。

引入依赖：

	io.springfox
	springfox-swagger2
	2.7.0


	io.springfox
	springfox-swagger-ui
	2.7.0

启动类添加注解：

@SpringBootApplication
@RestController
@EnableSwagger2
public class DemoApplication {
   public static void main(String[] args) {
	SpringApplication.run(DemoApplication.class, args);
}
   
   @GetMapping("/hello")
   public String hello() {
	   return "hello spring security";
   }
}

包装类的属性添加注解：

package com.imooc.dto;

import io.swagger.annotations.ApiModelProperty;

public class UserQueryCondition {
    
	private String username;
	
	@ApiModelProperty(value="用户年龄起始值")
	private int age;
	
	@ApiModelProperty(value="用户年龄终止值")
	private int ageTo;
	
	private String xxx;

	public String getUsername() {
		return username;
	}

	public void setUsername(String username) {
		this.username = username;
	}

	public int getAge() {
		return age;
	}

	public void setAge(int age) {
		this.age = age;
	}

	public int getAgeTo() {
		return ageTo;
	}

	public void setAgeTo(int ageTo) {
		this.ageTo = ageTo;
	}

	public String getXxx() {
		return xxx;
	}

	public void setXxx(String xxx) {
		this.xxx = xxx;
	}
	
}

效果：

还有其它注解平时经常用的就不说了，类和方法上都有对应注解。

其它注解：

- @Api()用于类； 
表示标识这个类是swagger的资源 
- @ApiOperation()用于方法； 
表示一个http请求的操作 
- @ApiParam()用于方法，参数，字段说明； 
表示对参数的添加元数据（说明或是否必填等） 
- @ApiModel()用于类 
表示对类进行说明，用于参数用实体类接收 
- @ApiModelProperty()用于方法，字段 
表示对model属性的说明或者数据操作更改 
- @ApiIgnore()用于类，方法，方法参数 
表示这个方法或者类被忽略 
- @ApiImplicitParam() 用于方法 
表示单独的请求参数 
- @ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam
--------------------- 
作者：兴国First 
来源：CSDN 
原文：https://blog.csdn.net/u014231523/article/details/76522486 
版权声明：本文为博主原创文章，转载请附上博文链接！