Spring集成Swagger,3步自动生成API文档

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

创新互联建站是一家集网站建设,寿县企业网站建设,寿县品牌网站建设,网站定制,寿县网站建设报价,网络营销,网络优化,寿县网站推广为一体的创新建站企业,帮助传统企业提升企业形象加强企业竞争力。可充分满足这一群体相比中小企业更为丰富、高端、多元的互联网需求。同时我们时刻保持专业、时尚、前沿,时刻以成就客户成长自我,坚持不断学习、思考、沉淀、净化自己,让我们为更多的企业打造出实用型网站。

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,功能调试

代码

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

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 classSwaggerConfig {
    @Bean
    publicDocketdocket() {
        return newDocket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.starter"))
                .paths(PathSelectors.any())
                .build();
    }

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

3. (可选)代码中引用Swagger注解,增加接口文档。

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

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

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

启动Spring项目,打开文档页面

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

 Spring集成Swagger,3步自动生成API文档

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

Spring集成Swagger,3步自动生成API文档


网页题目:Spring集成Swagger,3步自动生成API文档
文章源于:http://scyanting.com/article/jsdcod.html