ruoyi前后端分离访问swagger
时间: 2023-05-10 14:02:28 浏览: 317
RuoYi前后端不分离项目整合LDAP
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的使用,可以方便地管理和测试接口文档,提高开发效率和代码质量。
阅读全文