在Sping开发REST接口服务时，API文档是不可缺少的一个重要部分。Swagger框架定义了完整的REST接口文档规范，提供了强大的页面测试功能，能够调试和可视化API接口服务，并且将文档融合到代码中，让维护文档和修改代码整合为一体，使得修改代码逻辑的同时方便的修改文档说明。

成都创新互联长期为超过千家客户提供的网站建设服务，团队从业经验10年，关注不同地域、不同群体，并针对不同对象提供差异化的产品和服务；打造开放共赢平台，与合作伙伴共同营造健康的互联网生态环境。为康乐企业提供专业的成都网站设计、网站建设，康乐网站改版等技术服务。拥有10多年丰富建站经验和众多成功案例,为您定制开发。

Spring集成Swagger只需3步配置，就能在线生成接口文档，调试API功能。

	代码文件	功能要点
SpringBoot集成Swagger	pom.xml	引入Swagger依赖：springfox-swagger2, springfox-swagger-ui
	SwaggerConfig.java	配置Swagger信息和扫描包路径
	可以使用Swagger注解增加API文档	@Api(tags={“xxx”}) @ApiOperation(“xxx”) @ApiParam(“xxx”) ......
Swagger自动生成接口文档	http://localhost:8011/swagger-ui.html	页面可调用API，功能调试

l 代码

Github下载：https://github.com/jextop/StarterApi/

l SpringBoot集成Swagger

1. 在pom.xml中添加Swagger依赖

    io.springfox
    springfox-swagger-ui
    2.7.0


    io.springfox
    springfox-swagger2
    2.7.0

2. 添加SwaggerConfig.java，配置文档信息和扫描包路径

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.starter"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SpringBoot搭建分布式Web服务脚手架")
                .license("Github开源项目")
                .licenseUrl("https://github.com/jextop")
                .build();
    }
}

3. （可选）代码中引用Swagger注解，增加接口文档。

- 不添加这些注解时，Swagger自动生成在线文档将使用默认信息。

- 修改代码功能逻辑时，同时维护文档信息。

@Api(tags = {"用户管理"})
@RestController
@RequestMapping("/")
public class SecurityController {
    @ApiOperation("用户登录")
    @GetMapping(value = "/login")
    public Object login(
            @RequestParam(required = false) String username,
            @ApiParam("密码计算公式：md5(b64(username + password)") @RequestParam(required = false) String password
    ) {
        // todo
    }
}

l 启动Spring项目，打开文档页面

1. http://localhost:8011/swagger-ui.html

2. 展开API信息，点击按钮”Try it out!”，调试接口功能。

另外有需要云服务器可以了解下创新互联scvps.cn，海内外云服务器15元起步，三天无理由+7*72小时售后在线，公司持有idc许可证，提供“云服务器、裸金属服务器、高防服务器、香港服务器、美国服务器、虚拟主机、免备案服务器”等云主机租用服务以及企业上云的综合解决方案，具有“安全稳定、简单易用、服务可用性高、性价比高”等特点与优势，专为企业上云打造定制，能够满足用户丰富、多元化的应用场景需求。

网站名称：Spring集成Swagger，3步自动生成API文档-创新互联
文章分享：http://lswzjz.com/article/dcodgs.html