Swagger2

1 Swagger2概念

Swagger 是一款RESTFUL接口的、基于YAML、JSON语言的文档在线自动生成、代码自动生成的工具.

2 Swagger2入门案例

1 在springboot 项目工程pom.xml中添加依赖

   <!--swagger依赖--><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version></dependency>

2 编写一个配置类

@Configuration//配置类
@EnableSwagger2//开启使用swagger
public class Swagger2Configuration {@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).pathMapping("/")  //请求路径.select().apis(RequestHandlerSelectors.basePackage("com.zf"))//作用范围,在那个包下.paths(PathSelectors.any()) //指定包下所有请求.build().apiInfo(new ApiInfoBuilder().title("租房 ResutFul Api文档")//标题.description("租房  ResutFul Api文档......") //描述.version("v1.0") //版本.build());}}

3 在入口类之上加入注解

@ComponentScan(basePackages={"com.zf"})//扫描swagger配置
@EnableSwagger2......

4 编写controller层

@RestController
@RequestMapping("/brand")
public class BrandController {@Autowiredprivate BrandService brandService;//查询列表@GetMappingpublic Result<Brand> findAll(){//1.调用serviceList<Brand> brandList = brandService.findAll();if(brandList!=null ||brandList.size()>0){/*** 参数1表示状态，true或者false* 参数2表示调用状态码* 参数3表示信息* 参数4表示获取的数据*/return new Result<Brand>(true, StatusCode.OK,"查询成功",brandList);}else{return new Result<Brand>(false, StatusCode.ERROR,"查询失败");}}
}

5 测试,访问 http://localhost:9011/swagger-ui.html#/

为了效果展示，我们可以对swagger接口进行汉化

1 在controller类中加入注解

1 标签专门用来标注类的 @Api(tags = "品牌管理接口api")
2 标注方法 @ApiOperation("查询列表接口")
3 对方法参数进行说明    @ApiImplicitParams({//参数集合@ApiImplicitParam(name = "id",value = "主键",defaultValue = "325415")})

2 测试 http://localhost:9011/swagger-ui.html#/

注意:
如果参数类型是map类型的接口则不太适合swagger插件，如果说使用swagger作为api工具的话，那么在写接口的时候尽量不要用map作为参数类型.
1 因为在swagger界面,不能明确描述出map中需要的参数.
2 Java类中属性名, 如果都是大写,则swagger文档的中文说明没有.且swagger中的属性名根据对应实体类中的get、set方法名，如果get、set后缀不同名，swagger就认为有两个属性

Swagger2简介及入门案例相关推荐

Spring-Security 简介、入门案例详解、安全框架、权限验证 SSM项目使用 JavaConfig配置
Spring-Security 简介一.介绍二.详细步骤 1.创建一个maven项目添加web 框架. 2.导入依赖 3.项目整体结构 4.Spring 容器配置 5.servletContex ...
MyBatis Plus简介和入门案例
简介 MyBatis-Plus(以下简称MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发.提高效率而生. 润物无声只做增强不做改变,引入它不会对现有 ...
CXF使用教程（一）——简介以及入门案例
一.简介 Apache CXF是一个开源的Service框架,可以用于简化用户的service开发,基于CXF开发的应用可提供SOAP.XML/HTTP.RESTFUL HTTP或CORBA等服务.C ...
StreamSets简介和入门案例
目录一.Streamsets简介二.安装步骤 2.1 Java环境 2.2 打开文件数三.入门案例 3.1 本地文件解析到HDFS 1. 数据流的整体设计 2.管道流的具体设计步骤 3.2 My ...
JSqlParser入门系列(1)-JSqlParser简介及入门案例
简介 JSqlParser是一个SQL语句解析器.它将SQL转换为Java类的可遍历层次结构. 支持Oracle,SqlServer,MySQL,PostgreSQL等常用数据库.但各种数据库系统的S ...
SpringMVC（一）：SpringMVC简介、入门案例
目录一.SpringMVC概述二. SpringMVC入门案例 1.案例实现步骤 2.案例类和注解三.SpringMVC案例运行流程 1. 启动服务器初始化过程 2.单次请求过程四.bean加 ...
【MyBatis-Plus】简介入门案例
?? 博客主页: ?? 00年出生,即将进入职场闯荡,目标赚钱,可能会有人觉得我格局小.觉得俗,但不得不承认这个世界已经不再是以一条线来分割的平面,而是围绕财富旋转的球面,成为有钱人不是为了去掌控球体 ...
Vue安装配置以及入门案例
Vue Vue简介 Vue (读音 /vjuː/,类似于 view) 是一套用于构建用户界面的渐进式框架.与其它大型框架不同的是,Vue 被设计为可以自底向上逐层应用.Vue 的核心库只关注视图层,不 ...
流式计算storm核心组件介绍以及入门案例---跟着就能在本地跑起来的storm项目
关于storm的基础,参照我这篇文章:流式计算storm 关于并发和并行,参照我这篇文章:并发和并行关于storm的并行度解释,参照我这篇文章:storm的并行度解释关于storm的流分组策略,参 ...

Swagger2简介及入门案例

Swagger2

1 Swagger2概念

2 Swagger2入门案例

Swagger2简介及入门案例相关推荐

最新文章

热门文章