2.IDEA Spring +Swagger 配置全过程

标签: Spring boot  java  spring  swagger

Swagger作用
 接口文档在线自动生成
 功能测试
 Swagger可以充当前后端交流的重要桥梁,方便快捷,很实用。
 提供API在线测试功能


直接上过程:

1.首先创建一个Spring 项目
1-1、打开IDEA - 新建项目
在这里插入图片描述
1-2.根据自己需求填写相关信息
在这里插入图片描述
1-3、选择Spring 类型
在这里插入图片描述
1-4、填写项目名称
在这里插入图片描述
2.配置Swagger Maven文件 pom.xml
2-1、在 增加Swagger 版本信息

<swagger.version>2.9.2</swagger.version>

2-2、在 增加依赖

		<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger.version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger.version}</version>
        </dependency>

3.创建Swagger配置类
3-1、配置位置
在这里插入图片描述
3-2、配置SwaggerConfig.java 编写(抄)代码

package com.example.demo.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
class SwaggerConfig {

    @Bean
    public Docket buildDocket() {
        return  new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())//调用下面apiInfo()方法
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo"))//注意这里的路径,新手容易在这里出错导致打不开。
                .paths(PathSelectors.any())
                .build();

    }
    public ApiInfo apiInfo() {
        return  new ApiInfoBuilder()
                .title("swagger2 API")
                .description("小型demo")
                .termsOfServiceUrl("http://www.163.com")//这里可以是项目地址
                .version("1.0.1")
                .build();
    }
}

4.编写一个测试类 Stu
4-1、位置
在这里插入图片描述
4-2、Stu代码

package com.example.demo;
//---------为了方便测试,我这里只写两个成员,并给它相庆的get set方法
public class Stu {
    private String name;
    private Integer age;

    public Stu() {
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

5.conteroller控制层
5-1、位置
在这里插入图片描述
5-2、StuController.java

package com.example.demo;

import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
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.RestController;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

@RestController
@RequestMapping("/Stu")
public class StuController {
    static Map<Integer , Stu> map = new ConcurrentHashMap<>();
    @ApiOperation(value = "获取学生信息列表1")
    @RequestMapping(value = "",method = RequestMethod.GET)
    public List<Stu> getList() {
        List<Stu> list = new ArrayList<>(map.values());
        return  list;
    }

    @ApiOperation(value = "创建学生" , notes = "根据stu对象创建")
    @ApiImplicitParam(name = "Stu",value = "详情实体类",required = true,dataType = "Stu")
    @RequestMapping(value = "",method = RequestMethod.POST)
    public String postUser(@RequestBody Stu stu) {
        map.put(stu.getAge(),stu);
        return "添加成功~~~";
    }
}

6.运行
打开地址
http://localhost:8080/swagger-ui.html#

在这里插入图片描述

原创不易,分享请注明出处。

版权声明:本文为weixin_44690195原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/weixin_44690195/article/details/106657759

智能推荐

spring boot 配置 swagger2

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。 总体目标是使客户端和文件系统作为服务器以同样的速度来更新文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。 引入jar包 增加配置: com.aop8:扫描包的目录 增加Swagger2的扫描注解: 实际就增加 一行注解:@EnableSwagger2 修改拦截器 ...

Spring IOC加载全过程(转)

本文章以ClassPathXmlApplicationContext为切入口,常用的还有ContextLoaderListener类。 首先 **一般开始都是这样一句代码: 意思是加载xml文件创建一个ApplicationContext 的Spring 容器。 那么就从new ClassPathXmlApplicationContext这个构造方法开始看吧。进入源码: 其实可以看到他是来到这里了...

python基础(《Python编程从入门到实践》笔记)K

python基础语法 本笔记是对这本书的基础语法部分进行了学习: 因为本身有其他语言的编程基础,所以笔记仅仅对我自不熟悉的部分进行了记录 函数...

VUE脚手架html2canvas生成图片

长按识别二维码 下载插件 页面引入...

小程序login登录前后端实现

小程序login登录前后端实现 获取临时code 请求的接口 使用koa2 fly.js 登录验证 发送code...

猜你喜欢

QT(C++)面试总结

参考博客 QT信号槽机制的优缺点 (1)问题: 为什么Qt使用信号与槽机制而不是传统的回调函数机制进行对象间的通信呢? 回调函数的本质是“你想让别人的代码执行你的代码,而别人的代码你又不能动”这种需求下产生的。 回调函数是函数指针的一种用法,如果多个类都关注某个类的状态变化,此时需要维护一个列表,以存放多个回调函数的地址。对于每一个被关注的类,都需要做类似的工作,因此这种做...

【数据结构】栈与队列的面试题(一)

栈的简单认识和基本操作:点击打开链接 队列的简单认识和基本操作:点击打开链接 一.实现一个栈,要求实现Push(出栈),Pop(出栈),Min(返回最小值)的时间复杂度为O(1)。      (1.)方法一:创建两个栈来实现(Stack1,Stack2)                 &...

Pytorch设置random.seed()随机种子

转载自:https://blog.csdn.net/qq_16234613/article/details/81356876,本文只做个人记录学习使用,版权归原作者所有。 测试: 可以看到random.seed()对于import的文件同样有用。而且当你设置一个随机种子时,接下来的随机算法生成数可按照当前的随机种子按照一定规律生成。也就是一个随机种子就能重现随机生成的序列。 当随机种子设置在b文件...

从Python源代码里面证明你的猜想

看过《Python爬虫开发 从入门到实战》的同学,应该对multiprocessing这个模块比较熟悉,在书上我使用这个模块通过几行代码实现了一个简单的多线程爬虫: 运行效果如下图所示:   (没有看过我的书的人可能会质疑,multiprocessing不是多进程模块吗?为什么你说是多线程?看过书的读者不会有这个疑惑,因为我在书上解释过原因) 现在,你有一个函数,没有任何参数,但是仍然想...

UI基本控件(五):UIPikerView

UIPickerView 是使用旋转轮或类似老虎机来显示一组或多组值的视图。 时钟 应用中设置时间就是通过 UIPickerView 来实现的。      1.numberOfComponents:返回UIPickerView当前的列数 2. - (NSInteger)numberOfRowsInComponent:(...