swagger的三个项目及其作用

我们打开swagger的官网,会发现有三个swagger相关的项目,它们分别是

  1. swagger-editor 作用是通过写代码,生成文档描述(一个json文件或其他格式的api元数据文件)
  2. swagger-ui 通过请求文档描述(一个json文件)的数据,把api的文档显示在页面上
  3. swagger-codegenerator 通过文档描述,来生成实现的代码

如何在spring-boot项目中集成swagger?

我们使用springfox-swagger这个项目来把swagger的功能集成到我们的项目中来,springfox-swagger会自动扫描定义在Controller上的API的相关的注解,生成api的元数据json文件,然后提供的一个swagger的页面,当我们访问这个页面的时候,前端的js会去请求这个API的元数据文件,把API的相关信息展示出来,方便我们阅读和在线调试

集成到spring-boot web项目的步骤:

1.在项目的依赖一遍加入springfox-swagger的相关的依赖

由于我用的构建工具是gradle,所以就用下边的方式来引入依赖,

  1. compile group: 'io.springfox', name: 'springfox-swagger-ui', version: '2.9.2'
  2. compile group: 'io.springfox', name: 'springfox-swagger2', version: '2.9.2'

2.定义swagger的配置类,引入启用swaggger

在spring-boot项目可以自动扫描到的包下边,配置以下的配置类:

  1. import org.springframework.context.annotation.Bean;
  2. import org.springframework.context.annotation.Configuration;
  3. import springfox.documentation.builders.ApiInfoBuilder;
  4. import springfox.documentation.service.ApiInfo;
  5. import springfox.documentation.service.Contact;
  6. import springfox.documentation.spi.DocumentationType;
  7. import springfox.documentation.spring.web.plugins.Docket;
  8. import springfox.documentation.swagger2.annotations.EnableSwagger2;
  9. /**
  10. * Created with Intellij IDEA
  11. *
  12. * @author: jiaoyiping
  13. * Mail: jiaoyiping@gmail.com
  14. * Date: 2018/11/22
  15. * Time: 15:38
  16. * To change this template use File | Settings | Editor | File and Code Templates
  17. */
  18. @Configuration
  19. @EnableSwagger2
  20. public class SwaggerConfig {
  21. @Bean
  22. public Docket customDocket() {
  23. return new Docket(DocumentationType.SWAGGER_2)
  24. .apiInfo(apiInfo());
  25. }
  26. private ApiInfo apiInfo() {
  27. Contact contact = new Contact("焦一平", "http://www.cnblogs.com/jiaoyiping/", "jiaoyiping@gmail.com");
  28. return new ApiInfoBuilder()
  29. .title("元数据管理API接口")
  30. .description("工具链元数据管理")
  31. .contact(contact)
  32. .version("1.1.0")
  33. .build();
  34. }
  35. }

3.在Controller里边定义API的相关的注解

以下是一个API注解的例子:

  1. @RequestMapping(value = "/checkprojectcode/{projectcode}", method = RequestMethod.GET)
  2. @ApiOperation(value = "检查项目编号是否已经存在")
  3. public ResponseEntity<String> checkProjectCodeExists(@PathVariable("projectcode") String projectCode) {
  4. ResponseEntity<String> result;
  5. if (projectService.isProjectCodeExist(projectCode)) {
  6. result = ResponseEntity.ok("项目编号已存在");
  7. } else {
  8. result = ResponseEntity.ok("项目编号不存在");
  9. }
  10. return result;
  11. }

@ApiOperation注解提供了api的名称和描述信息

最终效果

启动项目,访问项目路径下的 v2/api-docs 这个地址,可以看到生成的json数据

访问项目路径下的 swagger-ui.html路径,可以查看和调试我们写的api的信息,所以的被@Controller注解的类都会显示在和这个页面上,添加了额外的api主机的接口,会有额外的描述信息

如何在spring-boot web项目中启用swagger的更多相关文章

  1. 重新学习Spring一--Spring在web项目中的启动过程

    1 Spring 在web项目中的启动过程 Spring简介 Spring 最简单的功能就是创建对象和管理这些对象间的依赖关系,实现高内聚.低耦合.(高内聚:相关性很强的代码组成,既单一责任原则:低耦 ...

  2. Spring在Web项目中的三种启动加载的配置

    在最近的项目中,使用到了spring相关的很多东西,有点把spring的配置给搞混了,从网上查到的资料以及整理了一下. 在Web项目中,启动spring容器的方式有三种,ContextLoaderLi ...

  3. 阿里P7级教你如何在Spring Boot应用程序中使用Redis

    在Spring Boot应用程序中使用Redis缓存的步骤: 1.要获得Redis连接,我们可以使用Lettuce或Jedis客户端库,Spring Boot 2.0启动程序spring-boot-s ...

  4. 最简单的spring boot web项目

    搭建效果为: 直接在网页输入请求,在页面中显示一行文字:Hello,Spring Boot 与一般的wen项目不同的地方: 1.不需要配置web.xml 文件,但需要注解@SpringBootAppl ...

  5. spring boot web项目在IDEA下热部署解决办法(四步搞定)

    最近在用spring boot 做一个web站点,修改了类.html.js等,刷新页面,没有生效,非要手动去make一下或者重启,大大降低了开发效率. 什么是热部署? 应用启动后会把编译好的Class ...

  6. Spring Boot Web开发中Thymeleaf模板引擎的使用

    这里使用的是idea 1.新建Spring Boot项目 File-->New-->Project...,然后选择左边的Spring Initializr-->Next,可根据自己的 ...

  7. 第三章 Maven构建 Java Spring Boot Web项目

    3.1   认识Srping Boot Spring Boot是一个框架,是一种全新的编程规范,它的产生简化了对框架的使用,简化了Spring众多的框架中大量的繁琐的配置文件,所以说Spring Bo ...

  8. Spring Boot- 用idea新建spring boot web项目

    1.新建project 2.选择Spring Initializr,next 3.输入项目信息,next 4.选择web依赖以及Spring Boot的版本,next 5.Finish 6.Enabl ...

  9. spring boot:在项目中引入第三方外部jar包集成为本地jar包(spring boot 2.3.2)

    一,为什么要集成外部jar包? 不是所有的第三方库都会上传到mvnrepository, 这时我们如果想集成它的第三方库,则需要直接在项目中集成它们的jar包, 在操作上还是很简单的, 这里用luos ...

随机推荐

  1. CSS之优先级

    css的优先级 所谓CSS优先级,即是指CSS样式在浏览器中被解析的先后顺序. 样式表中的特殊性描述了不同规则的相对权重,它的基本规则是: 1 内联样式表的权值最高               sty ...

  2. Linux之源码安装nginx,并按照作业一描述的那样去测试使用

    作业五:源码安装nginx,并按照作业一描述的那样去测试使用 [root@localhost nginx]# yum install gcc-* glibc-* openssl openssl-dev ...

  3. JS_高程5.引用类型(3)Array类型-检测数组

    1. instanceof操作符(ECMAScript3) 对于一个网页,或者是一个全局作用域而言,使用instanceof操作符来检测数组就可以得到满意的结果. 语法:if(value instan ...

  4. Uva11582 Colossal Fibonacci Numbers!(同余模定理+快速幂)

    https://vjudge.net/problem/UVA-11582 首先明确,斐波那契数列在模c的前提下是有循环节的.而f[i] = f[i-1]+f[i-2](i>=2)所以只要有两个连 ...

  5. pygame-KidsCanCode系列jumpy-part15-PowerUp加速器

    这一节我们给游戏增加点额外的奖励,大多数游戏中都会有金币.装备啥的来激励玩家,在jumpy这个游戏中,我们也可以增加类似的道具:加速器.效果图如下: 档板上会随机出现一些加速器(power up),小 ...

  6. dom4j解析xml字符串实例

    DOM4J 与利用DOM.SAX.JAXP机制来解析xml相比,DOM4J 表现更优秀,具有性能优异.功能强大和极端易用使用的特点,只要懂得DOM基本概念,就可以通过dom4j的api文档来解析xml ...

  7. 【转】Wireshark和Fiddler分析Android中的TLS协议包数据(附带案例样本)

    本文转自:http://www.wjdiankong.cn/wireshark%E5%92%8Cfiddler%E5%88%86%E6%9E%90android%E4%B8%AD%E7%9A%84tl ...

  8. idea 集成sonarLint检查代码bugs

    1.目标 idea集成sonar的代码检查,实现可以在提交代码前就检查你的代码,而不是将代码提交之后,之后再去检查. Sonar可以从以下七个维度检测代码质量,而作为开发人员至少需要处理前5种代码质量 ...

  9. [Python设计模式] 第20章 挨个买票——迭代器模式

    github地址:https://github.com/cheesezh/python_design_patterns 迭代器模式 迭代器模式,提供一种方法顺序访问一个聚合对象中各个元素,而又不暴露该 ...

  10. Effective Java 第三版——76. 争取保持失败原子性

    Tips 书中的源代码地址:https://github.com/jbloch/effective-java-3e-source-code 注意,书中的有些代码里方法是基于Java 9 API中的,所 ...