tnblog
首页
视频
资源
登录

Swagger 在spring boot 的配置

6131人阅读 2021/10/25 19:45 总访问:1590780 评论:0 收藏:0 手机
分类: Java

一.创建一个项目,可以直接只添加web 的项目;

二.添加swagger的swagger ui 和swagger2:如下

1、 在Maven网站搜索springfox-swagger

2、  找到swagger ui,swagger2

3、 获取swagger ui的依赖

a.

b.

c.

       4、swagger2雷同swagger ui

它们2.9.2版本的依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->

<dependency>

    <groupId>io.springfox</groupId>

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

    <version>2.9.2</version>

</dependency>

 

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->

<dependency>

    <groupId>io.springfox</groupId>

    <artifactId>springfox-swagger2</artifactId>

    <version>2.9.2</version>

</dependency>

注意:一定要根据版本而示意

三、

创建一个Holle工程

四、创建一个config文件夹配置swagger

启动程序搜索:http://localhost:8080/swagger-ui.html

就可以看见自己的swagger了

五、配置swagger的详细信息(所以代码可根据源码思路查找)

六、过滤接口

过滤接口一般要用到select(),用到select()一定要用到build();

在select和build之间还可以点出两个方法:apis()和paths(),如上

 

七、根据不同环境是否启用swagger即监测环境

八、分组

九.最重要的一步声明该类是swagger的(一定要)

一般用@Api(),其中@Api里面的value目前没发现有什么用


十、实体类

1、创建实体及实体注释

2、引入实体及创建方法

效果图如下:

方法的注释

 

@ApiOperation("方法名称")

    @GetMapping(value = "/get")

    public String getinfo2(@ApiParam("参数名称") String name) {

        return "hello";

}

注意:建议少用参数注释

 


评价

使用Swagger创建webapi文档描述---详解

在前后端分离开发中,作为后端如何给前端提供有效直观的接口文档呢?没错,就是使用swagger 俗称“丝袜哥”教程:一、首先...

.net core webapi 使用Swagger调试时传递一个参数问题

默认提供的参数没有加双引号不行的,加个双引号就行了

C中webapi结合Swagger的使用

一、使用nuget下载Swagger包 命令:Install-Package Swashbuckle二、Swagger配置 1、安装完Swashbuckle后,nuget会将相关...

.net core 3.1 Identity Server4 (Swagger UI授权)

.net core 3.1 Identity Server4 (Swagger UI授权)[TOC] Identity Server 4的目录:https://www.tnblog.net/hb/article/...

.NET Core使用NSwagger实现Api文档生成与版本控制。生成xml文件

参考代码下载地址:https://download.tnblog.net/resource/index/ba55ad0850ca4b71bc56855d0b4782d1一:下载NSwag环境Insta...

vs注释失效,提示xml注释没有放到有效得元素上,造成Swagger生成注释也失效

vs注释失效,提示xml注释没有放到有效得元素上,造成swagger生成注释也失效。原因很简单.....方法上面还有一个默认的生成没...

.net core设置Swagger为起始页

方法一:使用中间件来设置app.Use(next=&gt;asynccontext=&gt; { if(context.Request.Path==&quot;/&quot;) { context....

Abp Swagger方法重载

代码:services.AddSwaggerGen(c =&gt; { c.ResolveConflictingActions(apiDescriptions =&gt; apiDescriptions.First()); });

ABP Xml为Swagger接口页添加详细注释

我们选中我们Application层的项目,右键“属性”,勾选为Xml生成文档,如下图所示。在你的 项目名.Web.Host 的startup目录...

spring boot +Swagger+token

文章借鉴于://https://www.jianshu.com/p/6e5ee9dd5a61一、pom的相关依赖&lt;!--版本控制2.5.5--&gt; &lt;parent&gt; &l...

spring boot +Swagger+mssql +lombok+mybatis的ListDto 参数

一、参数为list实体model时(注意list参数一定要用对应的类型接收传回的参数,不然会报错)接口效果注意list参数默认是必填,...

Swagger调试报错 ​TypeError: Failed to fetch

swagger调试报错 TypeError: Failed to fetch可能性1:接口是https,但是swagger请求的url还是http可能性2:请求地址限制

Swagger设置https

可以尝试使用:Schemes.Add(NSwag.OpenApiSchema.Https);services.AddSwaggerDocument(a=&gt; { a.Title=&quot;接口项目&...

后端 API 接口文档 Swagger 使用指南

前言作为一个以前后端分离为模式开发小组,我们每隔一段时间都进行这样一个场景:前端人员和后端开发在一起热烈的讨论&quot...

把多个api Swagger整合到一个Swagger里面。api 整合

原理就是使用api网关就行了,比如ocelot。 把api都统一到一个项目里边就好办了
没有个性,不需要签名
排名
4
文章
473
粉丝
3
评论
2
ICP备案 :渝ICP备18016597号-1
网站信息:2018-2025TNBLOG.NET
技术交流:群号656732739
联系我们:contact@tnblog.net
公网安备:50010702506256
欢迎加群交流技术