#免费

swagger v2.2.19

源码属性

源码简介

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码，允许 API 来始终保持同步。Swagger 让部署管理和使用功能强大的 API 从未如此简单。

swagger主要包含了以下三个部分：
swagger editor：基于浏览器的编辑器，我们可以使用它编写我们OpenApi规范(yaml或者json配置）
Swagger UI：他会将我们编写的OpenApi规范呈现为交互式的API文档，后文我将使用浏览器来查看并且操作我们的RestApi
Swagger Codegen：它可以通过OpenApi规范定义的任何API生成服务器存根和客户端SDK来简化构建过程

swagger的使用

1、新建springboot项目
2、导入相关依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

<!-- 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>

3、启动类中添加@EnableSwagger2注解
@enableSwagger2：是springfox提供的一个注解，代表swagger2相关技术开启,会扫描当前类所在包，以及子包中所有的类型中的注解，做swagger文档的定值
4、编写一个简单api接口

@RestController
public class HelloController {
    
    @GetMapping(\"/get\")
    public String get() {
        return \"get\";
    }
    
    @PostMapping(\"/post\")
    public String post() {
        return \"post\";
    }
    
    @RequestMapping(\"/hello\")
    public String hello() {
        return \"hello\";
    }
}

5、启动项目，并在浏览器输入http://localhost:8080/swagger-ui.html进行swagger-ui界面访问

亿码酷站普通用户

收藏 海报 链接