在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文档的管理和测试。