2、集成swagger文档

wangdch426

于 2024-09-28 22:30:26 发布

阅读量83

点赞数 2

分类专栏： java项目文章标签： java

本文链接：https://blog.csdn.net/qq_38658071/article/details/142623033

版权

java项目专栏收录该内容

3 篇文章 0 订阅

订阅专栏

Springfox已经停止更新了 , Spring官网推荐了Springdoc 来整合swagger

1、在pom添加maven依赖

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.6.0</version>
</dependency>
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
    <version>2.6.0</version>
</dependency>

2、编写controller测试

package com.exam.controller;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Tag(name = "名称",description = "接口描述信息")
@RequestMapping("/person")
public class PersonController {

    @Operation(summary = "方法概要",description = "方法描述",hidden = false)
    @GetMapping("/add")
    public String addPerson(String s) {
        return "str";
    }
}

3、访问http://localhost:8080/swagger-ui/index.html