Swagger與Linux集成的步驟如下:
Swagger是一個基于Java的API文檔生成工具,因此你需要一個Java開發環境。你可以使用OpenJDK或Oracle JDK來安裝Java。
sudo apt update
sudo apt install openjdk-11-jdk
如果你使用Maven或Gradle來構建你的項目,確保你已經正確配置了依賴項。
在你的 pom.xml
文件中添加Swagger依賴項。
<dependencies>
<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.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.any())
.paths(PathSelectors.any())
.build();
}
}
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.any())
.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端點。你可以點擊每個端點來查看請求和響應的詳細信息。
以上步驟是在Linux系統上集成Swagger的基本流程,具體實現可能會因項目需求和環境差異而有所不同。