springboot中使用swagger

Apollo 发布于2019-08-16 16:41 / 827人阅读

摘要：在做项目的时候对于的规范特别重要以前用了感觉挺好用但是就是有点麻烦现在中可以使用注解的方式来逆向生成文档以下是使用步骤在文件中引入依赖在项目的配置文件中添加一个文件夹里面添加一个配置类用来描述哪些包下面会被扫描变成文档网页文档网页文档

在做项目的时候对于api的规范特别重要,以前用了swagger,感觉挺好用,但是就是有点麻烦,现在springboot中可以使用注解的方式来逆向生成swagger文档,以下是使用步骤:
1.在pom文件中引入依赖

    
        io.springfox
        springfox-swagger2
    
    
        io.springfox
        springfox-swagger-ui

2.在项目的配置文件中添加一个config文件夹,里面添加一个配置类,用来描述哪些包下面会被扫描变成swagger
文档
@Configuration
@EnableSwagger2
public class Swagger2Configuration {

@Bean
public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.manage"))
            .paths(PathSelectors.any())
            .build();
}

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("网页api文档")
            .description("网页api文档")

// .termsOfServiceUrl("/")

            .version("1.0")
            .build();
}

}
在Java类中添加Swagger的注解即可生成Swagger接口，常用Swagger注解如下：
@Api：修饰整个类，描述Controller的作用
@ApiOperation：描述一个类的一个方法，或者说一个接口
@ApiParam：单个参数描述
@ApiModel：用对象来接收参数
@ApiModelProperty：用对象接收参数时，描述对象的一个字段
@ApiResponse：HTTP响应其中1个描述
@ApiResponses：HTTP响应整体描述
@ApiIgnore：使用该注解忽略这个API
@ApiError ：发生错误返回的信息
@ApiImplicitParam：一个请求参数
@ApiImplicitParams：多个请求参数
@ApiImplicitParam属性：
例子:
//首先在接口上面描述接口的作用,详情和参数
@Api(value="页面管理接口",description = "页面管理接口，提供页面的增、删、改、查")
public interface PageControllerApi {
@ApiOperation("分页查询页面列表")
@ApiImplicitParams({
@ApiImplicitParam(name="page",value = "页
码",required=true,paramType="path",dataType="int"),
@ApiImplicitParam(name="size",value = "每页记录
数",required=true,paramType="path",dataType="int")
})
public QueryResponseResult findList(int page, int size) ;
}

//使用@ApiModelProperty描述模型类的各个字段
@Data
public class QueryPageRequest {

//接受页面的条件参数
//站点id
@ApiModelProperty("页面id")
String pageId;

}

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/74123.html

新手上路-搭建项目-springboot-swagger2

摘要：新手上路搭建项目是一个接口文档软件界面如下添加这里使用版本可以正常使用配置文件测试新手上路。新手上路-搭建项目-springboot-swagger2 swagger2 是一个接口文档软件界面如下 showImg(https://segmentfault.com/img/bVOoim); gradle添加 compile(io.springfox:springfox-swagger...

XGBCCC 2019-08-14 18:38 评论0 收藏0
SpringBoot非官方教程 | 第十一篇：SpringBoot集成swagger2，构建优雅的R

摘要：另外很容易构建风格的，简单优雅帅气，正如它的名字。配置一些基本的信息。三写生产文档的注解通过注解表明该接口会生成文档，包括接口名请求方法参数返回信息的等等。四参考资料中使用构建强大的文档 swagger,中文拽的意思。它是一个功能强大的api框架，它的集成非常简单，不仅提供了在线文档的查阅，而且还提供了在线文档的测试。另外swagger很容易构建restful风格的api，简单优雅帅气...

荆兆峰 2019-08-16 10:44 评论0 收藏0
SpringBoot 实战 (五) | 集成 Swagger2 构建强大的 RESTful API

摘要：今天给你们带来集成的教程。接口返回结果不明确。这些痛点在前后端分离的大型项目上显得尤为烦躁。接口返回结果非常明确，包括数据类型，状态码，错误信息等。生成后的文件依赖如下这里使用的是的版本。另外，关注之后在发送可领取免费学习资料。微信公众号：一个优秀的废人如有问题或建议，请后台留言，我会尽力解决你的问题。前言快过年了，不知道你们啥时候放年假，忙不忙。反正我是挺闲的，所以有时间写 b...

Rindia 2019-08-16 15:12 评论0 收藏0