Springboot 集成 Swagger

1、问题描述

  随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了:前端渲染、先后端分离的形态,而且前端技术和后端技术在各自的道路上越走越远。 前端和后端的唯一联系,变成了API接口;API文档变成了前后端开发人员联系的纽带,变得越来越重要,swagger就是一款让你更好的书写API文档的框架,而且swagger可以完全模拟http请求,入参出参和实际情况差别几乎为零。

  没有API文档工具之前,大家都是手写API文档的(维护起来相当困难),在什么地方书写的都有,有在confluence上写的,有在对应的项目目录下readme.md上写的,每个公司都有每个公司的玩法,无所谓好坏。但是能称之为“框架”的,估计也只有swagger

2、操作步骤

   2.1配置pom.xml

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

<parent>

       <groupId>org.springframework.boot</groupId>

       <artifactId>spring-boot-starter-parent</artifactId>

       <version>1.4.0.RELEASE</version>

   </parent>

 

  <properties>

    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

  </properties>

 

  <dependencies>

    <!-- junit -->

    <dependency>

      <groupId>junit</groupId>

      <artifactId>junit</artifactId>

      <scope>test</scope>

    </dependency>

    <!-- spring boot -->

    <dependency>

          <groupId>org.springframework.boot</groupId>

          <artifactId>spring-boot-starter-web</artifactId>

    </dependency>

    <!-- swagger -->

    <dependency>

        <groupId>io.springfox</groupId>

        <artifactId>springfox-swagger2</artifactId>

        <version>2.5.0</version>

    </dependency>

    <!-- swagger-ui -->

    <dependency>

        <groupId>io.springfox</groupId>

        <artifactId>springfox-swagger-ui</artifactId>

        <version>2.5.0</version>

    </dependency>

  </dependencies>

   2.2启动类

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

package com.mao.swagger;

 

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.EnableAutoConfiguration;

import org.springframework.boot.autoconfigure.SpringBootApplication;

 

/**

 * Hello world!

 *

 */

@EnableAutoConfiguration

@SpringBootApplication(scanBasePackages = "com.mao")

public class DemoApp {

 

    public static void main(String[] args) throws Exception {

        SpringApplication.run(DemoApp.class, args);

    }

     

}

    2.3配置config

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

package com.mao.swagger.config;

 

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

 

import io.swagger.annotations.ApiOperation;

import springfox.documentation.builders.RequestHandlerSelectors;

import springfox.documentation.spi.DocumentationType;

import springfox.documentation.spring.web.plugins.Docket;

import springfox.documentation.swagger2.annotations.EnableSwagger2;

 

@Configuration

@EnableSwagger2

public class SwaggerConfig {

     

    @Bean

    public Docket swaggerSpringMvcPlugin() {

        return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).build();

    }

     

}

 2.4配置controller

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

package com.mao.swagger.controller;

 

import org.springframework.http.HttpStatus;

import org.springframework.http.MediaType;

import org.springframework.web.bind.annotation.RequestBody;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestMethod;

import org.springframework.web.bind.annotation.RequestParam;

import org.springframework.web.bind.annotation.RestController;

 

import com.mao.swagger.beans.ResObject;

import com.mao.swagger.beans.User;

 

import io.swagger.annotations.Api;

import io.swagger.annotations.ApiImplicitParam;

import io.swagger.annotations.ApiImplicitParams;

import io.swagger.annotations.ApiOperation;

 

/**

 * Hello world!

 *

 */

@Api(description = "用户接口")

@RestController

@RequestMapping("/demoController")

public class DemoController {

 

    @ApiOperation(value = "新增用户" ,  notes="新增注册")

    @RequestMapping(value="/createUser",method=RequestMethod.POST,consumes= MediaType.APPLICATION_JSON_VALUE)

    public ResObject createUser(@RequestBody User user){

        System.out.println("createUser:::"+user.toString());

        return new ResObject(HttpStatus.OK.value(), "新增成功.");

    }

 

    @ApiOperation(value = "修改用户" ,  notes="修改用户")

    @RequestMapping(value="/updateUser",method=RequestMethod.POST,consumes= MediaType.APPLICATION_JSON_VALUE)

    public ResObject updateUser(@RequestBody User user){

        System.out.println("updateUser:::"+user.toString());

        return new ResObject(HttpStatus.OK.value(), "修改成功.");

    }

 

    @ApiOperation(value = "删除用户" ,  notes="删除用户")

    @ApiImplicitParams({

        @ApiImplicitParam(name = "userId", value = "用户标识", required = true, paramType = "query", dataType = "String")

    })

    @RequestMapping(value="/deleteUser",method=RequestMethod.DELETE)

    public ResObject deleteUser(@RequestParam("userId") String userId){

        System.out.println("deleteUser:::"+userId);

        return new ResObject(HttpStatus.OK.value(), "删除成功.");

    }

 

    @ApiOperation(value = "查询用户" ,  notes="查询用户")

    @ApiImplicitParams({

        @ApiImplicitParam(name = "userId", value = "用户标识", required = true, paramType = "query", dataType = "String")

    })

    @RequestMapping(value="/queryUser",method=RequestMethod.GET)

    public ResObject queryUser(@RequestParam("userId") String userId){

        System.out.println("queryUser:::"+userId);

        User user = new User(userId, "张三""******""mao2080@sina.com");

        return new ResObject(HttpStatus.OK.value(), user);

    }

 

}

3、效果展示

按照上面的启动之后访问:http://localhost:8080/swagger-ui.html  发现找不到接口

后面排查是因为没有添加扫描包

重启之后再刷新即可

点击demo-controller可以看到详细接口

点击具体接口可以看到具体参数

点击try it out! 可以测试接口。

后台打印日志

4、附件下载

swagger-demo.zip

5、参考网站

https://blog.csdn.net/i6448038/article/details/77622977

https://blog.csdn.net/blackmambaprogrammer/article/details/72354007

6、推广阅读

Sagger常用参数用法

 

转载自:http://www.cnblogs.com/mao2080/

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/510121.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

email类型

<!DOCTYPE html> <html><head><meta charset"utf-8" /><title></title></head><body><form action"demo_form.php"method"get">请输入您的email地址: <input type"email" n…

优秀程序员的 18 大法则

经过多年的积累&#xff0c;我发现&#xff0c;下面这些基本的指导法则&#xff0c;可以帮助我成为一个更加高效的程序员。 程序设计法则&#xff0c;与设计和工程的原理密切相关。下面这些编程法则帮助我让我获益匪浅&#xff0c;所以我想分享给大家&#xff0c;希望也能帮助大…

ros学习(1)工作空间创建和功能包

&#xff11;.创建空间 mkdir -p ~/testROS_ws/src cd ~/testROS_ws/src catkin_init_workspace 2.编译工作空间 cd ~/testROS_ws catkin_make catkin_maek install &#xff13;.设置环境变量 &#xff14;.创建功能包 cd ~/testROS_ws/src 格式&#xff1a; catkin…

Hbase 表名修改

禁用表&#xff1a;disable ods_temp:artcile_tableName快照生成&#xff1a;snapshot ods_temp:artcile_tableName, artcile_tableName_Snapshot克隆快照为新的名字&#xff1a;clone_snapshot artcile_tableName_Snapshot, ods_temp:article_tableName删除快照&#xff1a;de…

url类型

<!DOCTYPE html> <html><head><meta charset"utf-8" /><title></title></head><body><form action"demo_form.php"method"get">请输入网址: <input type"url" name"us…

低效程序员的7个坏习惯

程序员总是想做到尽可能的高效&#xff0c;但很多人往往会觉得力不从心。这是因为他们在多年的编码过程中养成了一些不好的习惯。下面这7个坏习惯绝对是软件工程师需要改掉的。 1.缺乏激情 这已经是一个老生常谈的话题了&#xff0c;但却是真理。写了多年的代码后&#xff0c;程…

Storm消费Kafka异常 - topic其中两个分区达到某个值不进行消费,持续阻塞

Kafka消费storm&#xff0c;突然有两个分区无法消费数据(或重复消费无法提交offset) offset是我们自己进行管理&#xff0c;kafka日志也是正常没有报错&#xff0c;storm日志也是没有报错~ 就是卡住了 1.尝试将partition为0,1的offset记录删除&#xff0c;重新跑一遍&#xff…

ros(2) 发布者publisher的编程实现

&#xff11;.创建功能包 cd ~/testROS_ws/src catkin_create_pkg topic_publisher std_msgs rospy roscpp geometry_msgs turtlesim cd ~/testROS_ws/src/topic_publisher/src 2.编辑代码 tourch test.cpp /*** 该例程将发布turtle1/cmd_vel话题&#xff0c;消息类型ge…

为什么跳槽加薪会比内部调薪要高?

有网友在知乎提问&#xff1a; 最近在思考一个问题&#xff0c;为什么跳槽往往意味着加薪&#xff1f; 如果一个人确有价值&#xff0c;为什么在原来的公司没有在薪水上体现出来&#xff1f;如果没有价值&#xff0c;为什么跳槽以后就会加薪&#xff1f;还是可以单纯的解释为&a…

浏览器多代理配置 - SwitchyOmega

转自 https://www.switchyomega.com/settings/ 下载链接&#xff1a;https://proxy-switchyomega.com/download/ 情景模式 代理服务器 代理服务器可以支持 HTTP、HTTPS、SOCKS4、SOCKS5 代理协议。SOCKS 代理协议不支持验证。下图以配置 Shadowsocks 的 SOCKS5 代理协议为例。…

number类型

step&#xff1a;数字间隔 <!DOCTYPE html> <html><head><meta charset"utf-8" /><title></title></head><body><form action"demo_form.php"method"get">请输入数值: <input type&qu…

ROS(3)订阅者subscriber编程实现

cd ~/testROS_ws/src/topic_publisher/src 创建代码pose_subscriber.cpp /*** 该例程将订阅/turtle1/pose话题&#xff0c;消息类型turtlesim::Pose*/#include <ros/ros.h> #include "turtlesim/Pose.h"// 接收到订阅的消息后&#xff0c;会进入消息回调函数…

居然还能这样——程序员加薪的新方法

我的朋友A君是个典型的.NET开发人员&#xff0c;技术不错&#xff0c;人品也不错&#xff0c;在一家小公司&#xff08;姑且称为甲公司&#xff09;做项目开发&#xff0c;是技术骨干。 3个月前&#xff0c;他找到我说想跳槽&#xff0c;让我帮忙介绍工作。我说为什么想跳了&am…

Hive 禁止提交 大范围磁盘扫描任务(禁止提交where条件包含未分区过滤)

参考书籍&#xff1a;Hive编程指南 如果用户需要做一个查询&#xff0c;查询条件是全盘扫描。Hive会不得不读取每个文件目录&#xff0c;但这种宽范围的磁盘扫描还是比较少见的。   但是&#xff0c;如果表中的数据以及分区个数都非常大的话&#xff0c;执行这样一个包含有所…

range类型

输入包含一定范围内的数字 <!DOCTYPE html> <html><head><meta charset"utf-8" /><title></title></head><body><form action"demo_form.php"method"get">请输入数值: <input type&qu…

程序员真的很穷吗?

前几天一位做市场的同事跑过来问&#xff0c;池老师&#xff0c;我有一位朋友&#xff0c;快30了&#xff0c;想转行写程序&#xff0c;您觉得有戏吗&#xff1f;我看了看满目疮痍的他说&#xff0c;如果是你就没戏。 30多岁转行做程序员当然可行&#xff0c;毕竟历史上存在一些…

Hive 行转列,列传行 - Impala 暂不支持

注&#xff1a;Impala 不支持 lateral view explode 一、行转列 (对某列拆分&#xff0c;一列拆多行) 使用函数&#xff1a;lateral view explode(split(column, ,)) num eg: 如表&#xff1a;t_row_to_column_tmp 数据如下&#xff0c;对tag列进行拆分 SQL代码&#xff1a…

ros(4)话题的自定义消息

&#xff11;.首先创建msg文件 在cd ~/testROS_ws/src/topic_publisher/src新建person.msg string name uint8 age uint8 sexuint8 unknown 0 uint8 male 1 uint8 female 2 修改package.xml 添加这两句 <build_depend>message_generation</build_depend&g…

Hive 外部表关联分区数据

0. 说明 已经安装好Hadoop和hive环境&#xff0c;hive把元数据存储在mysql数据库。这里仅讨论外部表和HDFS的关联&#xff0c;并且删掉外部表之后&#xff0c;对HDFS上的文件没有影响。 1. 在HDFS创建分区&#xff0c;并存有文件 手工创建或者由程序在HDFS上生成了分区目录&a…

日期选择器date、week、time、datetime、datetime-local类型

下面只写两个类型的代码案例&#xff0c;其他都大同小异 date类型&#xff1a; <!DOCTYPE html> <html><head><meta charset"utf-8" /><title>hello</title></head><body><form action"demo_form.php"…