博客

Swagger 简答的入门使用

前言

接口文档作为软件开发过程中有着非常重要的作用，它可以作为开发及测试人员系统工作的重要依据，特别是在目前流行的前后端分离开发模式中，接口文档更是作为前后端开发人员协同开发，以及测试人员编写测试用例的重要参考文档，一般的方式都存在一个问题就是——

文档同步问题

，而 Swagger 就解决了这个问题

一、Swagger是什么？

swagger是一套基于OpenAPI规范构建的开源工具，使用RestApi

1、代码变，文档变

2、跨语言，支持多种语言

3、swagger-ui 呈现出来的是一份可交互式的API文档，可以直接在文档页面尝试API的调用

4、可以将文档规范导入相关工具（postman、soapui），这些工具将会为我们自动地创建自动化测试。

二、使用步骤

1.创建Spring项目，导入Swagger包

导包如下：

 	<!--https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

2.新建Swagger配置类

代码如下（示例）：

@Configuration
@EnableSwagger2 //开启Swagger2
public class SwaggerConfig {
	@Bean
	public Docket docket(){
	return new Docket(DocumentationType.SWAGGER_2)
	.apiInfo(apiInfo())
	}
	
	private ApiInfo apiInfo(){
        Contact DEFAULT_CONTACT = new Contact("","","");
        return new ApiInfo(
                "CC-SwaggerApi 文档",
                "Api Documentation",
                "1.0",
                "https://mail.qq.com",
                DEFAULT_CONTACT,
                "Apache 2.0",
                "http://www.baidu.com",
                new ArrayList());
    }
}

主要是看源码，ApiInfo 源码进去看



这就是默认值 直接拷贝到你自己（new ApiInfo）里就行

3.创建Controller 运行项目

你自己打开的地址为：localhost:+你的端口号/swagger-ui.html

总结

以上就是今天要讲的内容，本文仅仅简单介绍了Swagger的使用.