springboot集成Swagger2「建议收藏」

springboot集成Swagger2「建议收藏」Swagger2简介 我们提供Restful接口的时候,API文档是尤为的重要,它承载着对接口的定义,描述等。它还是和API消费方沟通的重要工具。在实际情况中由于接口和文档存放的位置不同,我们很难及时的去维护文档。1.随项目自动生成强大RESTful API文档,减少工作量2.API文档与代码整合在一起,便于同步更新API说明3.页面测试功能来调试每个RESTful API…

大家好,又见面了,我是你们的朋友全栈君。

Swagger2简介

       我们提供Restful接口的时候,API文档是尤为的重要,它承载着对接口的定义,描述等。它还是和API消费方沟通的重要工具。在实际情况中由于接口和文档存放的位置不同,我们很难及时的去维护文档。

1.随项目自动生成强大RESTful API文档,减少工作量
2.API文档与代码整合在一起,便于同步更新API说明
3.页面测试功能来调试每个RESTful API

项目搭建

    添加依赖:
    

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

创建Swagger2配置类

导入相应的包即可。将指定扫描包下的注解 改成 自己的包名称

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.sss"))// 指定扫描包下面的注解
                .paths(PathSelectors.any())
                .build();
    }
    // 创建api的基本信息
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("集成Swagger2构建RESTful APIs")
                .description("集成Swagger2构建RESTful APIs")
                .termsOfServiceUrl("https://www.baidu.com")
                .contact("itlike")
                .version("1.0.0")
                .build();
    }
}

新建测试类:

@Api(value="用户controller",tags={"用户操作接口"})
@RestController
public class userController {

    @Autowired
    private HeroService heroService;

        // 根据当前的id获取记录
        @ApiOperation(value="获取Hero信息",notes="注意问题点",httpMethod="GET")
        @ApiImplicitParams({@ApiImplicitParam(name="id",value="用户id",dataType="Long", paramType = "path")})
        @GetMapping("/test/{id}")
        @ResponseBody
        public Hero test(@PathVariable("id") Integer id, Model model) {

            Hero hero = heroService.getOneHero(id);
            return hero;
        }
    }

启动类,访问   http://localhost:8080/swagger-ui.html

springboot集成Swagger2「建议收藏」

点击获取信息展开详细信息:

springboot集成Swagger2「建议收藏」

查询结果:

springboot集成Swagger2「建议收藏」

到此,springboot集成swagger2完成。

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

发布者:全栈程序员-用户IM,转载请注明出处:https://javaforall.cn/147163.html原文链接:https://javaforall.cn

【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛

【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...

(0)
blank

相关推荐

  • Java学习之Swing Gui编程

    Java学习之SwingGui编程0x00前言前面的使用的Gui是基于Awt去进行实现,但是在现实写Gui中AWT实际运用会比较少。上篇:Java学习之AWTGUI编程上上篇:Jav

    2021年12月12日
  • Linux实现字符设备驱动的基础步骤

    Linux实现字符设备驱动的基础步骤

    2021年12月10日
  • activiti7实战教程(一)集成用户系统

    activiti7实战教程(一)集成用户系统新建SpringBoot项目版本号2.6.3 <?xmlversion=”1.0″encoding=”UTF-8″?><projectxmlns=”http://maven.apache.org/POM/4.0.0″xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”xsi:schemaLocation=”http://maven.apache.org/POM/4.0.0https://maven.a

  • Java安全之JBoss反序列化漏洞分析

    Java安全之JBoss反序列化漏洞分析0x00前言看到网上的Jboss分析文章较少,从而激发起了兴趣。前段时间一直沉迷于工具开发这块,所以打算将jboss系列反序列化漏洞进行分析并打造成GUI

    2021年12月13日
  • 倒立摆的simulink模型搭建

    倒立摆的simulink模型搭建倒立摆的simulink模型搭建1.倒立摆基本背景:倒立摆,InvertedPendulum,是典型的多变量、高阶次,非线性、强耦合、自然不稳定系统。倒立摆系统的稳定控制是控制理论中的典型问题,在倒立摆的控制过程中能有效反映控制理论中的许多关键问题,如非线性问题、鲁棒性问题、随动问题、镇定、跟踪问题等。因此倒立摆系统作为控制理论教学与科研中典型的物理模型,常被用来检验新的控制理论和…

  • latex中求和符号正下方的符号怎么打_累加符号上下标的意义

    latex中求和符号正下方的符号怎么打_累加符号上下标的意义放在左上角的时候\sum^n:∑n\sum^n∑n放在正上方的时候\sum\limits^n:∑n\sum\limits^n∑n​放在右下角的时候\sum_{k=1}:∑k=1\sum_{k=1}∑k=1​放在正下方的时候\sum\limits_{k=1}:∑k=1\sum\limits_{k=1}k=1∑​

    2022年10月11日

发表回复

您的电子邮箱地址不会被公开。

关注全栈程序员社区公众号