swagger

官网

优点

  1. api文档与api定义同步更新。

  2. 直接运行在线测试api接口。


springboot 集成 swagger

  1. pom导入

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
</dependency>

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
</dependency>

  1. 配置swagger

    @Configuration
    @EnableSwagger2 //开启swagger
    public class SwaggerConfig{
    // docket 用于配置扫描的包,接口等
    @Bean
    public Docket docket(){
    return new Docket()......
    }

    //配置作者的信息
    public ApiInfo apiInfo(){
    return new ApiInfo()......
    }
    }

  2. 注解

    1. @Api

    2. @ApiModel

    3. @ApiModelProperty

    4. @ApiOperation

    5. @ApiResponse

    6. @ApiResponses

    7. @ApiIgnore

    8. @Profile

    9. @ApiImplicitParams

    10. @ApiImplicitParam

  3. 启动项目,访问:http://localhost:8080/swagger-ui.html (8080为项目对应端口)

©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

友情链接更多精彩内容