在Linux系统上高效集成Swagger,通常涉及以下几个步骤:
Swagger是一个基于Java的API文档生成工具,因此你需要一个Java开发环境。你可以使用OpenJDK或Oracle JDK来安装Java。
sudo apt update
sudo apt install openjdk-11-jdk
如果你使用Maven或Gradle来构建你的项目,确保你已经正确配置了依赖项。
在你的 pom.xml
文件中添加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>
在你的 build.gradle
文件中添加Swagger依赖项:
dependencies {
implementation 'io.springfox:springfox-swagger2:2.9.2'
implementation 'io.springfox:springfox-swagger-ui:2.9.2'
}
创建一个Swagger配置类来启用Swagger文档生成。
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
.paths(PathSelectors.any())
.build();
}
}
启动你的Spring Boot或Spring MVC应用程序。Swagger应该会自动生成API文档,并且你可以在浏览器中访问 http://localhost:8080/swagger-ui.html
(假设你的应用程序运行在端口8080上)来查看和测试API文档。
打开浏览器并访问 http://localhost:8080/swagger-ui.html
,你应该能够看到Swagger UI界面,其中列出了你的所有API端点。你可以点击每个端点来查看请求和响应的详细信息。
Swagger Editor是一个Swagger UI的在线编辑器,你可以自己搭建一个,也可以使用官方的。
wget https://github.com/swagger-api/swagger-editor/archive/refs/tags/v3.16.1.tar.gz
tar -xvf v3.16.1.tar.gz
rm v3.16.1.tar.gz
mkdir /opt/swagger
cd /opt/swagger
npm init -y
npm install express --save
index.js
文件,并添加以下内容来启动HTTP服务器:const express = require('express');
const app = express();
const port = 8081;
app.use('/swagger-editor', express.static('swagger-editor-3.16.1'));
app.listen(port, () => {
console.log('Swagger Editor is running at http://localhost:' + port);
});
node index.js
现在,你可以通过访问 http://localhost:8081
来使用Swagger Editor。
你可以进一步自定义Swagger UI,例如添加认证、自定义样式等。
通过以上步骤,你应该能够在Linux环境中成功集成Swagger与Spring Boot,并使用Swagger UI来测试和文档化你的API。