swagger入门

最新推荐文章于 2024-01-04 16:17:37 发布

不知道999

最新推荐文章于 2024-01-04 16:17:37 发布

阅读量564

点赞数

本文链接：https://blog.csdn.net/weixin_67338832/article/details/128592037

版权

spring 专栏收录该内容

22 篇文章 0 订阅

订阅专栏

5.3 开发一个controller用于测试

1.前后端分离的特点

前后端分离是的前端与后端之间的职责更加明确

后台：负责业务处理

前端：负责显示逻辑

在这种情况下，前端和后端可以分别交付给专业的开发人员去做，所以是必须要定义前后端直接的对接

接口，否则各自为是则项目无法集成，这时就需要一个文档来定义统一的接口。

2.在没有swagger之前

在没有swagger之间，我们可以使用word，excel等功能来书写接口定义文档，但又有一个弊端，即：

在接口发送改变时需要及时的同步接口文档，否则实际的接口与接口文档不相符，则接口文件就失去了

作用，甚至会起到反作用。

3.swagger的作用

根据在代码中使用自定义的注解来生成接口文档，这个在前后端分离的项目中很重要。这样做的好处是

在开发接口时可以通过swagger将接口文档定义好，同时也方便以后的维护。

4.swagger的优点

号称时最流行的API框架

接口文档在线生成，避免同步的麻烦

可以支持在线对接口执行测试

支持多语言

5.集成swagger

5.1 新建springboot项目

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

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

package com.ruojuan.swagger1.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * ruojuan
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                .paths(PathSelectors.ant("/**")) //项目名
                .build();

    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SwaggerDemoAPIDOC")
                .description("SwaggerDemoAPIDOC")
                .version("1.0")
                .termsOfServiceUrl("https://www.baidu.com").build();
    }
}

此时运行就会报错：

改变成2.5.11,启动成功啦：

注意访问地址：

5.2 集成swagger

5.3 开发一个controller用于测试

新建一个controller：

package com.ruojuan.swagger1.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;
import java.util.Map;

/**
 * @author ruojuan
 * @site www.ruojuan.com
 * @company 玉渊工作室
 * @create 2023年01月07日 16:58
 **/
@RestController
@RequestMapping("/swagger")
public class HelloController {

    @RequestMapping("hello")
    public Map hello(){
        Map map = new HashMap();
        map.put("code",200);
        map.put("msg","操作成功！！！");
        return map;
    }
}

此时会多一行接口：

@RquestMapping代表所有的请求方式。

补充：

添加api会对案例进行补充：

添加@ApiOperation

5.4 启动服务，验证集成效果

6.swagger常用注解

注解	位置	作用	参数
@Api	类	标识这个类是swagger的资源	tags：说明该类的作用，参数是个数组，可以填多个。
value="该参数没什么意义，在UI界面上不显示，所以不用配置"
description = "用户基本信息操作"
@ApiOperation	方法	表示一个http请求的操作	value="方法的用途和作用"
notes="方法的注意事项和备注"
tags：说明该方法的作用，参数是个数组，可以填多个。
格式：tags={"作用1","作用2"}
@ApiParam	方法，参数	对参数使用说明（如：说明或是否必填等）	value="用户名" 描述参数的意义
name="name" 参数的变量名
required=true 参数是否必选
@ApiModel	类	表示对类进行说明，用于参数用实体类接收，一般用在 DTO上	description="描述实体的作用"
@ApiModelProperty	方法，字段	表示对model属性的说明	value="用户名" 描述参数的意义
name="name" 参数的变量名
required=true 参数是否必选
@ApiIgnore	类，方法，参数	表示这个方法或者类被忽略	无
@ApiImplicitParams	方法	包含多@ApiImplicitParam
@ApiImplicitParam	方法	表示单独的请求参数	name="参数名称"
value="参数说明"
dataType="数据类型"
paramType="query" 表示参数放在哪里
defaultValue="参数的默认值"
required="true" 表示参数是否必须传

更全面的信息可以参考官方说明文档：

swagger-annotations 1.3.10 APIhttps://docs.swagger.io/swagger-core/apidocs/index.html

7.swagger使用综合案例

准备：

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.11</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.ruojuan</groupId>
    <artifactId>swagger1</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>swagger1</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

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

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

SwaggerController:

package com.ruojuan.swagger1.controller;


import com.ruojuan.swagger1.model.User;
import io.swagger.annotations.*;
import org.springframework.web.bind.annotation.*;

import java.util.HashMap;
import java.util.Map;

/**
 * @author ruojuan
 * @site www.ruojuan.com
 * @company 玉渊工作室
 * @create 2023年01月07日 16:58
 **/
@RestController
@RequestMapping("/swagger/api")
@Api(tags = "swagger所有注解的讲解")
public class SwaggerController {


    @ApiOperation(value = "欢迎信息")
    @GetMapping("/hello")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "name", value = "名称", dataType = "string", paramType = "query", required = true),
            @ApiImplicitParam(name = "msg", value="消息", dataType = "string", paramType = "query", required = true)
    })
    public Object hello(String name, String msg) {
        Map<String, Object> map = new HashMap<>();
        map.put("code", 200);
        map.put("msg", "操作成功");
        map.put("info",name+":"+msg);
        return map;
    }

    @PostMapping("/register")
    @ApiOperation("注册用户接口")
    @ApiResponses({
            @ApiResponse(code = 5001001,message = "错误1"),
            @ApiResponse(code = 5001002,message = "错误2"),
            @ApiResponse(code = 5001003,message = "错误3")
    })
    public Object register(User user) {
        Map<String, Object> map = new HashMap<>();
        map.put("code", 5001002);
        map.put("msg", "操作成功");
        map.put("info",user);
        return map;
    }

    @PutMapping("/edit")
    @ApiOperation("修改用户信息")
    public Object edit(@RequestBody User user) {
        Map<String, Object> map = new HashMap<>();
        map.put("code", 200);
        map.put("msg", "操作成功");
        map.put("info",user);
        return map;
    }

    @DeleteMapping("/delete/{id}")
    @ApiOperation("删除用户")
    @ApiImplicitParam(name = "id", value="用户ID", dataType = "string", paramType = "path", required = true)
    public Object delete(@PathVariable("id") String id) {
        Map<String, Object> map = new HashMap<>();
        map.put("code", 200);
        map.put("msg", "操作成功");
        map.put("info",id);
        return map;
    }
}

model:

package com.ruojuan.swagger1.model;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

/**
 * @author ruojuan
 * @site www.ruojuan.com
 * @company 玉渊工作室
 * @create 2023年01月07日 17:20
 **/
@Data
@ApiModel(description = "用户信息")
public class User {

    @ApiModelProperty(value = "用户名", name="name", required = true)
    private String name;

    @ApiModelProperty(value = "密码", name="passwd", required = true)
    private String passwd;

}

以前都是输入网址进行调试的：

现在可以在swagger上进行调试：

Try it out -----》exucte

exucte相当于在地址栏进行输入

加入代码后：

展示：

8.会议OA之swagger

不知道999

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
swagger入门

在这种情况下，前端和后端可以分别交付给专业的开发人员去做，所以是必须要定义前后端直接的对接。在接口发送改变时需要及时的同步接口文档，否则实际的接口与接口文档不相符，则接口文件就失去了。根据在代码中使用自定义的注解来生成接口文档，这个在前后端分离的项目中很重要。在开发接口时可以通过swagger将接口文档定义好，同时也方便以后的维护。接口，否则各自为是则项目无法集成，这时就需要一个文档来定义统一的接口。前后端分离是的前端与后端之间的职责更加明确。后台：负责业务处理。前端：负责显示逻辑。
复制链接

扫一扫