前后端分离swagger配置

本文介绍了在前后端分离的项目中如何配置Swagger,包括导入相关依赖、进行配置步骤和项目的运行流程。
摘要由CSDN通过智能技术生成

3、运行

 

 




2、配置

@Configuration //托管给spring
@EnableSwagger2  //开启swagger功能的注解
public class SwaggerConfig {
    @Bean
    public Docket createRestApi(){
        //版本类型是swagger2
        return new Docket(DocumentationType.SWAGGER_2)
                //通过调用自定义方法apiInfo,获得文档的主要信息
                .apiInfo(apiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                .paths(Predicates.not(PathSelectors.regex("/error.*")))

//                .apis(RequestHandlerSelectors.basePackage("com.atguigu"))//扫描该包下面的API注解
//                .paths(PathSelectors.any())
                .build();
    }
    /**
     * 创建该API的基本信息(这些基本信息会展现在文档页面中)
     * 访问地址:http://项目实际地址/swagger-ui.html
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("使用Swagger2 构建REST
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
RuoYi是一个基于Spring Boot开发的前后端分离的快速开发平台,它的前端使用的是Vue.js框架,后端使用的是Spring Boot框架。在开发过程中,我们通常需要对接口文档进行管理和测试,这就需要使用Swagger进行接口文档的生成和测试。那么如何访问Swagger呢? 1. 在后端项目中添加Swagger依赖 在pom.xml中添加以下依赖: <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> 2. 添加Swagger配置类 在后端项目中添加配置SwaggerConfig,配置Swagger相关信息: @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("top.ruoyun.admin.system.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("RuoYi APIs") .description("Restful APIs document") .version("1.0") .build(); } } 3. 启动后端项目 启动后端项目,在浏览器中输入http://localhost:端口号/swagger-ui.html,即可进入Swagger页面。 4. 在前端项目中访问Swagger 在前端项目中添加axios依赖: npm install --save axios 在代码中使用axios进行接口访问: import axios from 'axios' //获取Swagger接口文档数据 export function getApiDocs() { return axios({ url: 'http://localhost:端口号/v2/api-docs', method: 'get' }) } //获取Swagger接口文档URL export function getApiDocsUrl() { return axios({ url: 'http://localhost:端口号/swagger-ui.html', method: 'get' }) } 在代码中调用getApiDocs()和getApiDocsUrl()函数,即可获取Swagger接口文档数据和URL。这样就可以在前端项目中访问Swagger,并进行接口文档的测试和管理了。 总的来说,在RuoYi前后端分离的开发过程中,访问Swagger的步骤比较简单,只需要在后端项目中添加Swagger依赖和配置类,然后在前端项目中使用axios进行接口访问即可。通过Swagger的使用,可以方便地管理和测试接口文档,提高开发效率和代码质量。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值