SpringBoot整合Swagger

<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>

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * Swagger的配置类
 * @author 陈加兵
 *
 */
@Configuration
public class SwaggerConfig {
	/**
	 * 创建用户API文档
	 * @return
	 */
	@Bean
	public Docket createRestUserApi() {
		return new Docket(DocumentationType.SWAGGER_2)
				.groupName("user")  
				.apiInfo(apiInfo())   //api的信息
				.select()
				.apis(RequestHandlerSelectors
						.basePackage("cn.tedu.mycat.controller"))   //添加包扫描
				.paths(PathSelectors.any()).build();

	}

	/**
	 * 创建API信息
	 */
	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				.title("api文档的标题")   //标题
				.description("api文档的描述")  //描述  
				.contact(    //添加开发者的一些信息
						new Contact("爱撒谎的男孩", "https://chenjiabing666.github.io",
								"18796327106@163.com")).version("1.0").build();
	}

}

@ApiOperation(value="根据用户Id获取用户信息",response=User.class,hidden=false)
	@ApiImplicitParams({
			@ApiImplicitParam(paramType = "path", name = "id", dataType="Integer", required = false, value = "用户的id", defaultValue = "1")
	})
	@GetMapping("/user/get/{id}")
	public Object getUser(@PathVariable("id")Integer id) {
		return new User(id, "陈加兵");
	}

<!-- swagger自动生成文档依赖 -->
	<dependency>
		<groupId>io.springfox</groupId>
		<artifactId>springfox-swagger2</artifactId>
		<version>${swagger-version}</version>
		<exclusions>
			<exclusion>
				<groupId>io.swagger</groupId>
				<artifactId>swagger-models</artifactId>
			</exclusion>
		</exclusions>
	</dependency>

	<dependency>
		<groupId>io.springfox</groupId>
		<artifactId>springfox-swagger-ui</artifactId>
		<version>${swagger-version}</version>
	</dependency>

	<!--导出到markdown文件的依赖 -->
	<dependency>
		<groupId>io.github.swagger2markup</groupId>
		<artifactId>swagger2markup</artifactId>
		<version>1.3.3</version>
	</dependency>
	
	<dependency>
		<groupId>ch.netzwerg</groupId>
		<artifactId>paleo-core</artifactId>
		<version>0.11.0</version>
		<scope>system</scope>
		<systemPath>${basedir}/src/main/webapp/WEB-INF/lib/paleo-core-0.11.0.jar</systemPath>
	</dependency>

	<dependency>
		<groupId>nl.jworks.markdown_to_asciidoc</groupId>
		<artifactId>markdown_to_asciidoc</artifactId>
		<version>1.0</version>
		<scope>system</scope>
		<systemPath>${basedir}/src/main/webapp/WEB-INF/lib/markdown_to_asciidoc-1.0.jar</systemPath>
	</dependency>

import java.net.URL;
import java.nio.file.Path;
import java.nio.file.Paths;
import io.github.swagger2markup.GroupBy;
import io.github.swagger2markup.Language;
import io.github.swagger2markup.Swagger2MarkupConfig;
import io.github.swagger2markup.Swagger2MarkupConverter;
import io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder;
import io.github.swagger2markup.markup.builder.MarkupLanguage;

/**
* 生成Markdown文件的类
*/
public class SwaggerTest {
	public static void main(String[] args) throws Exception {
	    Path outputFile = Paths.get("build/swagger");   //指定生成的目录和文件的名称swagger.md
	    Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
	            .withMarkupLanguage(MarkupLanguage.MARKDOWN)
	            .withOutputLanguage(Language.ZH)
	            .withPathsGroupedBy(GroupBy.TAGS)
	            .withGeneratedExamples()
	            .withoutInlineSchema()
	            .build();
	    Swagger2MarkupConverter converter = Swagger2MarkupConverter.from(new URL("http://localhost:8080/demo/v2/api-docs"))   //url是可以访问的在线json数据的url
	            .withConfig(config)
	            .build();
	    converter.toFile(outputFile);
	}
}