百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程网 > 正文

Swagger(丝袜哥) 快速入门 swagger菜鸟教程

yuyutoo 2024-10-12 01:50 2 浏览 0 评论

swagger(丝袜哥)

Swagger是一个简单但功能强大的API表达工具。它具有地球上最大的API工具生态系统,数以千计的开发人员,使用几乎所有的现代编程语言,都在支持和使用Swagger。使用Swagger生成API,我们可以得到交互式文档,自动生成代码的SDK以及API的发现特性等。


资源

官网

https://swagger.io/

在线编辑器

http://editor.swagger.io/

微服务整合Swagger,请看另一篇文章

Spring Cloud 整合Swagger 统一服务api


Swagger整合SpringBoot(单系统)

第三方(推荐)


https://github.com/SpringForAll/spring-boot-starter-swagger


依赖引入

<dependency>
<groupId>com.spring4all</groupId>
<artifactId>swagger-spring-boot-starter</artifactId>
<version>1.9.0.RELEASE</version>
</dependency>

在SpringBoot 启动类application 里面加入 @EnableSwagger2Doc 注解

加完注解后把项目启动起来,先看看效果 。访问路径默认都是localhost:端口号/swagger-ui.html


效果如图下:

他是会自动去扫描项目下的所有接口,这是项目里面自带的一些乱七八糟的,也不用去看这些。


我们可以在application.properties 文件中设置一些参数(这些都是最基本的,更多参数请参考官方文档)

#swagger标题
swagger.title=swagger titile
#swagger描述
swagger.description=swagger context
#swagger版本号
swagger.version=1.0.0

接下来,看运行效果,如图:

我们可以自己指定扫描路径,并为我们自己写的接口添加注释


创建一个接口类 MainController

@Api //SwaggerApi注解 作用于接口类上
@ApiOperation //SwaggerApi注解 作用于某个接口

@ApiParam //Swagger注解,作用于接口里面的参数

/**
* @Auther: wan
* @Date: 2021/4/7 16:41
* @Description: com.wan.eurekaserver2.controller
* @version: 1.0
* @Api swaggerApi注解 对当前类描述
*/
@RestController
@RequestMapping(
"/main")
@Api(value =
"用户管理",tags = {"用户管理"})
public class MainController {

/**
* @ApiOperation swaggerApi注解 对当前接口描述
* value:参数说明注解
* @ApiParam swagger注解说明
* name :参数名称
* required:是否必填
* example:写个示例
* value:参数说明注解
* @param name
* @
return
*/
@GetMapping(value=
"/getName")
@ApiOperation(value =
"获取wan列表")
public String getList(@ApiParam(name=
"name",required = true,type = "String",example = "例如:小明",value = "姓名") String name,
@ApiParam(name =
"age",required = true,type = "integer",example = "20",value = "年龄") Integer age){
return "user: name-"+name+",age-"+age;
}
}

Swagger 会自动扫描项目下所有接口,会把一些不需要展示的接口显示出来,我们就可以指定Swagger的扫描路径


在application.properties 配置文件中

#指定分组名称
swagger.docket.maincontroller.title=main-controller
#指定当前分组扫描的路径-这个路径就是我创建的那个MainController的路径,你们自行修改
swagger.docket.maincontroller.base-package=com.wan.eurekaserver2.controller

运行,看效果,如下图:

点击这个接口里面看看有啥,效果如下图:

接下来,我们看看如果参数是Object 的时候,怎么在Swagger中配置参数说明


创建一个wanController ,把它和MainController 放在不同的文件夹下面,如下图:

/**
* @Auther: wan
* @Date: 2021/4/7 17:22
* @Description: com.wan.eurekaserver2.wanController
* @version: 1.0
*/
@RestController
@RequestMapping(
"/wan")
@Api(value =
"wan管理1",tags = {"wan管理2"}) //@Api是接口类描述
public class wanController {

@GetMapping(
"/getWanList")
@ApiOperation(value =
"获取wan列表")//@ApiOperation 是类中当前接口描述、@ApiParam是接口中参数描述
public String getWanList(@ApiParam(value =
"用户对象", example = "{json}") User user){
return "getWanList:"+user.getName();
}

@PostMapping(
"/Delete")
@ApiOperation(value =
"删除Wan")
public String gnList(@ApiParam(value =
"id")Integer id){
return "删除成功:"+id;
}

}


在创建一个对象User,用来当请求参数,并加上注解


@ApiModel // 就是用来修饰对象的


@ApiModelProperty //修饰对象里面的属性的,value 可以配置属性说明,example 为参数示例

/**
* @Auther: wan
* @Date: 2021/4/8 10:34
* @Description: com.wan.eurekaserver2.model 用户管理
* @version: 1.0
*/
@ApiModel
public class User {
@ApiModelProperty(value =
"用户id",example = "1")
private Integer id;
@ApiModelProperty(value =
"姓名",example = "小明")
private String name;
@ApiModelProperty(value =
"年龄",example = "18")
private Integer age;

public
User(){

}

public Integer
getId() {
return id;
}

public void setId(Integer id) {
this.id = id;
}

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;
}

}


然后我们可以在配置一个分组,


在application.properties 中加入如下配置:

swagger.docket.wancontroller.title=wan-controller
swagger.docket.wancontroller.base-package=com.wan.eurekaserver2.wanController

配置好了,运行。


效果如下图:

看看第二个分组里面的接口


在Swagger中 还自带postman 的功能,可以对接口进行发起请求,测试,操作如下图:

出现如下页面:

发起请求后返回的结果,如下图:

到此,Swagger 基本使用就是如此了。

————————————————

相关推荐

野路子科技!2步教你把手机改造成一个FTP服务器,支持PC互传

哈喽,大家好,我是野路子科技,今天来给大家带来一个教程,希望大家喜欢。正如标题所言,就是教大家如何把售价改造成FTP服务器,而这个时候估计有朋友会问了,把手机改造成FTP服务器有什么用呢?现在有Q...

不得不看:别样于Server-U的群晖文件存储服务器的搭建与使用

我先前的作品中,有着关于Server-U的ftp文件存储服务器的搭建与访问的头条文章和西瓜视频,而且我们通过各种方式也给各位粉丝介绍了如何突破局域网实现真正意义上的公网访问机制技术。关于Server-...

Qt三种方式实现FTP上传功能_qt引入qftp库

FTP协议FTP的中文名称是“文件传输协议”,是FileTransferProtocol三个英文单词的缩写。FTP协议是TCP/IP协议组中的协议之一,其传输效率非常高,在网络上传输大的文件时,经...

Filezilla文件服务器搭建及客户端的使用

FileZilla是一个免费开源的FTP软件,分为客户端版本和服务器版本,具备所有的FTP软件功能。可控性、有条理的界面和管理多站点的简化方式使得Filezilla客户端版成为一个方便高效的FTP客户...

美能达柯美/震旦复印机FTP扫描怎么设置?

好多网友不知道怎么安装美能达/震旦复印机扫描,用得最多是SMB和FTP扫描,相对于SMB来说,FTP扫描安装步骤更为便捷,不容易出问题,不需要设置文件夹共享,所以小编推荐FTP来扫描以美能达机器为例详...

CCD(简易FTP服务器软件)_简单ftp服务器软件

CCD简易FTP服务器软件是一款很方便的FPT搭建工具,可以将我们的电脑快速变成一个FPT服务器。使用方法非常简单,只要运行软件就会自动生效,下载银行有该资源。该工具是不提供操作界面的,其他用户可以输...

Ubuntu系统搭建FTP服务器教程_ubuntu架设服务器

在Ubuntu系统上搭建FTP服务器是文件传输的一个非常实用方法,适合需要进行大量文件交换的场景。以下是一步步指导,帮助您在Ubuntu上成功搭建FTP服务器。1.安装vsftpd软件...

理光FTP扫描设置教程_理光ftp扫描设置方法

此教程主要用来解决WIN10系统下不能使用SMB文件夹扫描的问题,由于旧的SMB协议存在安全漏洞,所以微软在新的系统,WIN8/WIN10/SERVER201220162018里使用了新的SMB传...

纯小白如何利用wireshark学习网络技术

写在前面工欲善其事必先利其器!熟悉掌握一种神器对以后的工作必然是有帮助的,下面我将从简单的描述Wireshark的使用和自己思考去写,若有错误或不足还请批评指正。...

京东买13盘位32GB内存NAS:NAS系统安装设置教程

本内容来源于@什么值得买APP,观点仅代表作者本人|作者:yasden你没有看错,我在京东自营商城购买硬件,组装了一台13盘位,32GB内存的NAS,硬盘有13个盘位!CPU是AMD的5500!本文...

FileZilla搭建FTP服务器图解教程_filezilla server搭建ftp服务器

...

python教程之FTP相关操作_python ftps

ftplib类库常用相关操作importftplibftp=ftplib.FTP()ftp.set_debuglevel(2)#打开调试级别2,显示详细信息ftp.connect(“I...

xftp怎么用,xftp怎么用,具体使用方法

Xftp是一款界面化的ftp传输工具,用起来方便简单,这里为大家分享下Xftp怎么使用?希望能帮到有需要的朋友。IIS7服务器管理工具可以批量管理、定时上传下载、同步操作、数据备份、到期提醒、自动更新...

树莓派文件上传和下载,详细步骤设置FTP服务器

在本指南中,详细记录了如何在树莓Pi上设置FTP。设置FTP可以在网络上轻松地将文件传输到Pi上。FTP是文件传输协议的缩写,只是一种通过网络在两个设备之间传输文件的方法。还有一种额外的方法,你可以用...

win10电脑操作系统,怎么设置FTP?windows10系统设置FTP操作方法

打印,打印,扫描的日常操作是每一个办公工作人员的必需专业技能,要应用FTP作用扫描文件到电脑上,最先要必须一台可以接受文件的FTP服务器。许多软件都需要收费标准进行,但人们还可以应用Windows的系...

取消回复欢迎 发表评论: