Spring-Boot框架启用Swagger-UI页面来展示接口信息------Spring-Boot框架

已于 2023-10-23 15:59:24 修改
阅读量263 收藏
点赞数 1
分类专栏： # Spring框架 # Spring-Boot框架 JAVA 文章标签： java spring spring boot 后端 maven xml java-ee
于 2023-09-30 15:51:28 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2201_75960169/article/details/133435222
版权
JAVA 同时被 3 个专栏收录
533 篇文章 3 订阅
订阅专栏
Spring-Boot框架
138 篇文章 0 订阅
订阅专栏
Spring框架
131 篇文章 0 订阅
订阅专栏 

spring.servlet.multipart.max-file-size=10MB
spring.servlet.multipart.max-request-size=10MB
spring.web.resources.static-locations=/upload/
spring.mvc.pathmatch.matching-strategy=ant\_path\_matcher
spring.servlet.multipart.max-file-size=10MB
spring.servlet.multipart.max-request-size=10MB
spring.web.resources.static-locations=/upload/
spring.mvc.pathmatch.matching-strategy=ant\_path\_matcher
<?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.7.8</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.powernode</groupId>
    <artifactId>SpringBootVue</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>SpringBootVue</name>
    <description>SpringBootVue</description>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <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>
<!--        添加swagger的相关功能-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <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>

<?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.7.8</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.powernode</groupId>
    <artifactId>SpringBootVue</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>SpringBootVue</name>
    <description>SpringBootVue</description>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <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>
<!--        添加swagger的相关功能-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <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>

package com.powernode.springbootvue.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;

@Configuration//表明这是一个容器
@EnableSwagger2//启用swagger2
public class SwaggerConfig
{
    @Bean
    public Docket createRestApi()
    {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com"))//com包下所有api都交给swagger2管理
                .paths(PathSelectors.any()).build();
    }
    //此处是api文档页面显示信息
    private ApiInfo apiInfo()
    {
        return new ApiInfoBuilder()
                .title("演示项目api")//标题
                .description("演示项目")//描述
                .version("1.0")//版本
                .build();
    }
}

package com.powernode.springbootvue.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;

@Configuration//表明这是一个容器
@EnableSwagger2//启用swagger2
public class SwaggerConfig
{
    @Bean
    public Docket createRestApi()
    {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com"))//com包下所有api都交给swagger2管理
                .paths(PathSelectors.any()).build();
    }
    //此处是api文档页面显示信息
    private ApiInfo apiInfo()
    {
        return new ApiInfoBuilder()
                .title("演示项目api")//标题
                .description("演示项目")//描述
                .version("1.0")//版本
                .build();
    }
}

package com.powernode.springbootvue.controller;

import com.powernode.springbootvue.entity.User;
import javax.servlet.http.HttpServletRequest;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;

import java.io.File;
import java.io.IOException;

@RestController
public class 测试控制器
{
    @GetMapping("/user/get/{id}")
    public String 获取用户列表(@PathVariable int id)
    {
        System.out.println("我在这");
        System.out.println(id);
        return "获取用户信息成功";
    }
    @RequestMapping("/upload")
    public String up(String nickname, MultipartFile photo, HttpServletRequest request)
    {
        System.out.println(nickname);
        System.out.println(photo.getOriginalFilename());
        System.out.println(photo.getContentType());
        System.out.println(System.getProperty("user.dir"));
        String path = request.getServletContext().getRealPath("/upload/");
        System.out.println(path);
        try {
            saveFile(photo,path);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
        return "上传成功";
    }
    public void saveFile(MultipartFile photo,String path) throws IOException {
        File dir = new File(path);
        if(!dir .exists())
        {
            dir.mkdir();
        }
        File file = new File(path + photo.getOriginalFilename());
        photo.transferTo(file);
    }
    @RequestMapping("/user/helloGet")
    public String helloGet(@RequestParam(value = "nickname",required = false) String name)
    {
        return name;
    }
    @RequestMapping("/user/helloPost")
    public String helloPost(@RequestParam(value = "nickname",required = false) String name,String password)
    {
        System.out.println(name + password);
        return name;
    }
    @RequestMapping(value = "/PostTest",method = RequestMethod.POST)
    public void PostTest(User user)
    {
        System.out.println(user.toString());
    }
    @RequestMapping(value = "/PostTest1",method = RequestMethod.POST)
    //如果前端回传的json类型的数据,需要添加上@RequestBody这个注解,否则无法接收
    public void PostTest1(@RequestBody User user)
    {
        System.out.println(user.toString());
    }
    @RequestMapping("/user/**")
    public String test()
    {
        return "通配符请求";
    }
}

package com.powernode.springbootvue.controller;

import com.powernode.springbootvue.entity.User;
import javax.servlet.http.HttpServletRequest;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;

import java.io.File;
import java.io.IOException;

@RestController
public class 测试控制器
{
    @GetMapping("/user/get/{id}")
    public String 获取用户列表(@PathVariable int id)
    {
        System.out.println("我在这");
        System.out.println(id);
        return "获取用户信息成功";
    }
    @RequestMapping("/upload")
    public String up(String nickname, MultipartFile photo, HttpServletRequest request)
    {
        System.out.println(nickname);
        System.out.println(photo.getOriginalFilename());
        System.out.println(photo.getContentType());
        System.out.println(System.getProperty("user.dir"));
        String path = request.getServletContext().getRealPath("/upload/");
        System.out.println(path);
        try {
            saveFile(photo,path);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
        return "上传成功";
    }
    public void saveFile(MultipartFile photo,String path) throws IOException {
        File dir = new File(path);
        if(!dir .exists())
        {
            dir.mkdir();
        }
        File file = new File(path + photo.getOriginalFilename());
        photo.transferTo(file);
    }
    @RequestMapping("/user/helloGet")
    public String helloGet(@RequestParam(value = "nickname",required = false) String name)
    {
        return name;
    }
    @RequestMapping("/user/helloPost")
    public String helloPost(@RequestParam(value = "nickname",required = false) String name,String password)
    {
        System.out.println(name + password);
        return name;
    }
    @RequestMapping(value = "/PostTest",method = RequestMethod.POST)
    public void PostTest(User user)
    {
        System.out.println(user.toString());
    }
    @RequestMapping(value = "/PostTest1",method = RequestMethod.POST)
    //如果前端回传的json类型的数据,需要添加上@RequestBody这个注解,否则无法接收
    public void PostTest1(@RequestBody User user)
    {
        System.out.println(user.toString());
    }
    @RequestMapping("/user/**")
    public String test()
    {
        return "通配符请求";
    }
}

package com.powernode.springbootvue.interceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;

public class LoginInterceptor implements HandlerInterceptor
{
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("LoginInterceptor");
        //true是放行,false是拦截
        return true;
    }
}

package com.powernode.springbootvue.interceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;

public class LoginInterceptor implements HandlerInterceptor
{
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("LoginInterceptor");
        //true是放行,false是拦截
        return true;
    }
}
旧约Alatus
关注
  • 1
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
swagger接口文档改良添加左侧菜单.rar
07-28
基于swagger文档，进行左侧菜单改造，添加左侧菜单，快速导航菜单接口，后台接口api目录用-分割，如： XX系统-XX管理-XX列表
spring-boot集成swagger
09-30
1. **启动 Spring Boot 项目**：在完成以上配置后，启动项目，Swagger UI 将自动启用。 2. **访问 Swagger UI**：在浏览器中输入 `http://localhost:8080/swagger-ui/`（假设默认端口为 8080），查看生成的 API 文档...
swagger2 同一个实体用在多个不同的controller接口展示不同的字段 POST请求body
qq_34004646的博客
12-14 632
swagger2 同一个实体用在多个不同的controller接口展示不同的字段 自定义注解
Spring Boot集成Swagger框架
最新发布
zhencian的博客
04-28 1337
spring boot集成swagger
使用Swagger时Controller中的api接口显示不全问题
过于丰富，无法简介
10-30 1万+
前言： swagger是一个十分好用的api接口管理、测试框架，现在用的人也越来越多，lz两个公司两个项目都有使用这个做接口的测试和管理，由于之前就遇到过Controller中的api接口显示不全的问题，但当时使用postman直接忽略掉了，这个项目刚启动时就在想是不是会遇到类似的奇葩问题，果然是担心什么就会来什么，今天，它来了。花了很久的时间对接口进行了处理，找出了问题所在。先看一下具体的表现 ...
.net framework中webapi使用swagger进行接口文档展示
suxuelian的博客
10-07 3623
第四步：在SwaggerUI文件夹中，创建一个swagger_lang.js的js,用于对swagger进行汉化处理（注：这个文件必须添加，否则汉化将失败）第三步：创建一个“SwaggerControllerDescProvider”类，用于对swagger文档中的内容进行汉化处理。第一步：在nuget程序包管理中搜索“Swagger.Net”包和“Swagger.Net.UI”，然后进行安装。这里需要注意，新增的swagger_lang.js文件需要修改文件属性，将文件生成操作修改为“嵌入的资源”。
在 SpringBoot 项目中使用 Swagger 接口文档演示
华仔仔的博客
07-04 968
在一个项目开发过程中，当前端开发人员根据后端开发人员给出的 API 接口文档进行接口联调对接时，可能会出现这样的矛盾：前端开发人员抱怨后端开发人员给出的 API 接口文档和实际的情况有所出入，而后端开发人员由于繁重的开发任务已经身心俱疲，想到自己还要负责维护接口文档的任务更是不堪重负。这时就需要一个解决方案，希望它能够在后端开发人员进行接口开发时，能够帮助后端工程师自动生成相应的接口文档，当接口有变化时，也能够对文档进行及时更新，这样前端工程师在进行接口联调时，不会再出现发现文档和实际情况不一致的情况。幸运
spring-boot-tutorials-master.zip
06-19
在"spring-boot-tutorials-master.zip"这个压缩包中，我们找到了一系列关于Spring Boot的实战示例，涵盖了多个关键组件和技术，如Dubbo、RabbitMQ、Swagger2、缓存管理和JSP。接下来，我们将深入探讨这些知识点。 1...
在Spring Boot中使用swagger-bootstrap-ui的方法
08-28
在Spring Boot中使用swagger-bootstrap-ui的方法 Spring Boot是一款流行的Java框架，用于构建Web应用程序。swagger是一个流行的API文档生成工具，能够自动生成API文档。swagger-bootstrap-ui是基于swagger的UI组件...
spring-boot 禁用swagger的方法
08-28
在 Spring Boot 项目中，Swagger 是一个非常有用的工具，可以生成 API 文档，并提供 UI 界面来查看 API 的路径、参数等信息。但是，在生产环境中，我们需要禁用 Swagger，以避免泄露敏感信息。在本篇文章中，我们将...
spring-boot-swagger2-starter:swagger2弹簧靴
05-01
2. 配置Swagger2：创建一个配置类，通常命名为`Swagger2Config`，并使用`@EnableSwagger2WebMvc`注解启用Swagger2。在这个配置类中，我们可以设置Swagger的基本信息，如API版本、描述、联系人信息等。 ```java @...
springboot集成swagger接口列表不显示
CSDNY_88的博客
11-03 4388
springboot集成swagger接口列表不显示 我使用的是springboot 1.4.7 版本，swagger用的是2.5.0版本； 访问swagger-ui.html，页头正常显示，接口列表不显示，后台没报错，页面没报错 解决方法：将swagger2.5.0降一个版本为2.4.0，问题解决 不知道是为什么，之前总以为是swagger配置类写的有问题，或者是接口注解不标准的问题 （有很多接口没有使用swagger的注解）；后台改为2.4.0版本后，没用swagger注解的接口也显示出来了，只是没有描
Swagger的使用
weixin_45912987的博客
06-07 252
SwaggerConfig配置类 Controller层中接口如何显示在swagger上
Swagger新写的模块在页面不显示以及点击接口展开卡死问题
qq_45927587的博客
09-06 1104
Swagger找不到新写的模块和Swagger页面卡死
.net6基于swagger的轻量级,注入化的api-ui组件FytApi.MUI
Laity07的博客
11-22 854
在之前的API UI界面有用过AspNetCore.Knife4jUI的一个swagger ui库，今天偶然发现这个Fytapi-ui 界面很美观就学习了一下，看着还不错。
后端 API 接口文档 Swagger 使用指南
诗诗的远方
05-30 5838
swagger作为一款辅助性的工具，能大大提升我们的和前端的沟通效率,接口是一个非常重要的传递数据的媒介，每个接口的签名、方法参数都非常重要。一个良好的文档非常重要，如果采用手写的方式非常容易拼写错误，而swagger可以自动化生成参数文档，这一切都加快了我们的沟通效率。并且可以替代postman的作用。实在是开发编程必备良品啊。
Springboot基础学习之（二十一):Swagger基础学习(swagger信息介绍，配置扫描接口和开关，分组和接口注释）
m0_52479012的博客
04-17 3537
spring boot：swagger号称世界上最流行的API框架Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新直接运行，在线测试API支持多种语言 （如：Java，PHP等）
swagger不显示controller接口问题的汇总
qq_45748157的博客
04-04 2万+
swagger不显示接口问题汇总
Swagger Ui只显示部分接口的办法
热门推荐
山间明月江上清风的专栏
06-20 2万+
Swagger UI默认显示所有接口，连endpoint，jpa restful等接口也会显示 可以通过一下配置： @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api(){ return new Docket(DocumentationTy...
knife4j-openapi3-spring-boot-starter 使用
01-23
knife4j-openapi3-spring-boot-starter是一个用于在Spring Boot项目中集成Knife4j的依赖。它可以帮助我们简化Swagger UI和Swagger Bootstrap UI的添加，并自动生成API文档。 要使用knife4j-openapi3-spring-boot-starter，首先需要在项目的pom.xml文件中添加以下依赖： ```xml <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>3.0.2</version> </dependency> ``` 添加完依赖后，我们可以在Spring Boot的配置类上使用`@EnableKnife4j`注解来启用Knife4j： ```java @Configuration @EnableKnife4j public class SwaggerConfig { // 配置相关的Swagger信息 } ``` 接下来，我们可以在API接口的方法上使用Swagger相关的注解来标记接口和参数。例如，使用`@ApiOperation`注解来描述接口的作用，使用`@ApiParam`注解来描述参数的含义。 ```java @RestController @RequestMapping("/api") @Api(tags = "示例接口") public class ExampleController { @GetMapping("/hello") @ApiOperation("示例接口") public String hello(@ApiParam("姓名") @RequestParam String name) { return "Hello, " + name + "!"; } } ``` 最后，启动Spring Boot应用程序并访问Swagger UI的URL（默认为`/doc.html`），您将看到自动生成的API文档界面，其中包含了您标记的接口和参数信息。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值