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

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

yuyutoo 2024-10-12 01:50 3 浏览 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 基本使用就是如此了。

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

相关推荐

如何在HTML中使用JavaScript:从基础到高级的全面指南!

“这里是云端源想IT,帮你...

推荐9个Github上热门的CSS开源框架

大家好,我是Echa。...

前端基础知识之“CSS是什么?”_前端css js

...

硬核!知网首篇被引过万的论文讲了啥?作者什么来头?

整理|袁小华近日,知网首篇被引量破万的中文论文及其作者备受关注。知网中心网站数据显示,截至2021年7月23日,由华南师范大学教授温忠麟等人发表在《心理学报》2004年05期上的学术论文“中介效应检验...

为什么我推荐使用JSX开发Vue3_为什么用vue不用jquery

在很长的一段时间中,Vue官方都以简单上手作为其推广的重点。这确实给Vue带来了非常大的用户量,尤其是最追求需求开发效率,往往不那么在意工程代码质量的国内中小企业中,Vue占据的份额极速增长...

【干货】一文详解html和css,前端开发需要哪些技术?
【干货】一文详解html和css,前端开发需要哪些技术?

网站开发简介...

2025-02-20 18:34 yuyutoo

分享几个css实用技巧_cssli

本篇将介绍几个css小技巧,目录如下:自定义引用标签的符号重置所有标签样式...

如何在浏览器中运行 .NET_怎么用浏览器运行代码

概述:...

前端-干货分享:更牛逼的CSS管理方法-层(CSS Layers)

使用CSS最困难的部分之一是处理CSS的权重值,它可以决定到底哪条规则会最终被应用,尤其是如果你想在Bootstrap这样的框架中覆盖其已有样式,更加显得麻烦。不过随着CSS层的引入,这一...

HTML 基础标签库_html标签基本结构
HTML 基础标签库_html标签基本结构

HTML标题HTML标题(Heading)是通过-...

2025-02-20 18:34 yuyutoo

前端css面试20道常见考题_高级前端css面试题

1.请解释一下CSS3的flexbox(弹性盒布局模型),以及适用场景?display:flex;在父元素设置,子元素受弹性盒影响,默认排成一行,如果超出一行,按比例压缩flex:1;子元素设置...

vue引入外部js文件并使用_vue3 引入外部js

要在Vue中引入外部的JavaScript文件,可以使用以下几种方法:1.使用``标签引入外部的JavaScript文件。在Vue的HTML模板中,可以直接使用``标签来引入外部的JavaScrip...

网页设计得懂css的规范_html+css网页设计

在初级的前端工作人员,刚入职的时候,可能在学习前端技术,写代码不是否那么的规范,而在工作中,命名的规范的尤为重要,它直接与你的代码质量挂钩。网上也受很多,但比较杂乱,在加上每年的命名都会发生一变化。...

Google在Chrome中引入HTML 5.1标记

虽然负责制定Web标准的WorldWideWebConsortium(W3C)尚未宣布HTML5正式推荐规格,而Google已经迁移到了HTML5.1。即将发布的Chrome38将引入H...

HTML DOM 引用( ) 对象_html中如何引用js

引用对象引用对象定义了一个同内联元素的HTML引用。标签定义短的引用。元素经常在引用的内容周围添加引号。HTML文档中的每一个标签,都会创建一个引用对象。...

取消回复欢迎 发表评论: