在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"))
.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://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.50.0/swagger-editor.min.js
wget https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.50.0/swagger-editor.min.css
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" type="text/css" href="swagger-editor.css">
</head>
<body>
<div id="swagger-editor"></div>
<script src="swagger-editor.js"></script>
<script>
window.onload = function() {
const editor = SwaggerEditor({
url: "https://petstore.swagger.io/v2/api-docs",
dom_id: '#swagger-editor'
});
};
</script>
</body>
</html>
Apache:
sudo a2ensite default.conf
sudo systemctl restart apache2
Nginx:
sudo cp /etc/nginx/sites-available/default /etc/nginx/sites-available/default.backup
sudo nano /etc/nginx/sites-available/default
修改 server
塊中的 root
和 index
指令:
server {
listen 80 default_server;
listen [::]: 80 default_server;
root /var/www/html;
index index.html index.htm;
server_name _;
location / {
try_files $uri $uri/ =404;
}
}
保存并退出編輯器,然后重啟Nginx:
sudo systemctl restart nginx
現在,你應該能夠通過瀏覽器訪問 http://your_server_ip/swagger-ui
和 http://your_server_ip/swagger-editor
來查看和使用Swagger UI和Swagger Editor。