IT数码 购物 网址 头条 软件 日历 阅读 图书馆
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
图片批量下载器
↓批量下载图片,美女图库↓
图片自动播放器
↓图片自动播放器↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁
 
   -> 开发工具 -> SpringBoot——整合Swagger -> 正文阅读

[开发工具]SpringBoot——整合Swagger

1.IDEA中整合:

(1)在父工程中创建公共模块common(为了所有的模块都可以用Swagger):

?(2)在common中再创建一个子模块service_base:

(3)在service_base模块的src\main\java目录下创建一个叫配置类SwaggerConfig:

?内容如下:(基本内容固定)

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")//内容自定义
                .apiInfo(webApiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();
    }

    private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("网站-DEAR模块API文档")//内容自定义
                .description("本文档描述了DEAR模块微服务接口定义")//内容自定义
                .version("1.0")
                .contact(new Contact("lixioahan", "http://baidu.com",
                        "80848107@qq.com"))//内容自定义
                .build();
    }
}

(4)在需要使用到Swagger的模块的pom.xml中引入service_base依赖:

        <dependency>
            <!--此处路径更具自己的项目确定-->
            <groupId>com.lixiaohan</groupId>
            <version>0.0.1-SNAPSHOT</version>
            <artifactId>service_base</artifactId>
        </dependency>

(5)在需要使用的模块的启动类上加上@ComponentScan注解并设置扫描规则

@ComponentScan(basePackages = {"com.dodear"})//大括号里面的扫描规则根据自己项目确定

2.测试,展示效果:

(1)直接在Controller中进行测试:(其中使用到了MybatisPlus,只看效果)

@RestController
@RequestMapping("/userservice/tab-user")
@Api(description = "用户模块")//Swagger相关注解
public class TabUserController {

    @Autowired
    private TabUserService tabUserService;

    @GetMapping("FindByUserId/{uid}")
    @ApiOperation(value = "根据用户id查唯一用户")//Swagger相关注解
    public Result findAll(
            @ApiParam(name = "uid" , value = "用户的id",required = true)//Swagger相关注解
            @PathVariable Integer uid) throws IOException {
        List<TabUser> userlist = tabUserService.list(null);
        return Result.ok().data("userlist",userlist);
    }

}

(2)启动项目后注意使用的端口号,登录网址:http://localhost:8083/swagger-ui.html#!/? ??

即可看见如下界面,如过能看见自己写的接口表示Swagger整合成功

?

?整合成功!

  开发工具 最新文章
Postman接口测试之Mock快速入门
ASCII码空格替换查表_最全ASCII码对照表0-2
如何使用 ssh 建立 socks 代理
Typora配合PicGo阿里云图床配置
SoapUI、Jmeter、Postman三种接口测试工具的
github用相对路径显示图片_GitHub 中 readm
Windows编译g2o及其g2o viewer
解决jupyter notebook无法连接/ jupyter连接
Git恢复到之前版本
VScode常用快捷键
上一篇文章      下一篇文章      查看所有文章
加:2021-10-02 15:04:03  更:2021-10-02 15:04:45 
 
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁

360图书馆 购物 三丰科技 阅读网 日历 万年历 2024年11日历 -2024/11/16 1:23:52-

图片自动播放器
↓图片自动播放器↓
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
图片批量下载器
↓批量下载图片,美女图库↓
  网站联系: qq:121756557 email:121756557@qq.com  IT数码