在Linux環境下調試Swagger,可以參考以下步驟:
確保你的Linux系統上已經安裝了Node.js和npm。如果沒有安裝,可以參考Node.js官方文檔進行安裝。
npm init -y
npm install express --save
mkdir /opt/swagger
cd /opt/swagger
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
cd swagger-editor-3.16.1
npm install
node index.js
現在,你可以通過訪問 http://localhost:8081 來使用Swagger Editor。
cd /opt/swagger
wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v3.48.0.tar.gz
tar -xvf v3.48.0.tar.gz
rm v3.48.0.tar.gz
cd swagger-ui-3.48.0
npm install
node index.js
現在,你可以通過訪問 http://localhost:3000/api-docs 來使用Swagger UI。
sudo apt-get update
sudo apt-get install -y docker.io
sudo systemctl start docker
sudo systemctl enable docker
docker pull swaggerapi/swagger-ui:latest
docker pull swaggerapi/swagger-editor:latest
docker run -d -p 8080:8080 swaggerapi/swagger-ui:latest
docker run -d -p 8081:8080 swaggerapi/swagger-editor:latest
訪問 http://localhost:8080 查看Swagger UI,訪問 http://localhost:8081 查看Swagger Editor。
在你的Spring Boot項目中配置Swagger,可以參考以下步驟:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
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();
}
}
在你的Controller中使用Swagger注解來描述API。
通過以上步驟,你可以在Linux環境下配置和調試Swagger,方便API文檔的管理和測試。