在Ubuntu上配置Swagger主要涉及安装和配置Swagger Editor和Swagger UI,以及确保它们可以通过网络访问。以下是详细步骤:
首先,确保你的系统上已经安装了Node.js和npm。如果没有安装,可以通过以下命令进行安装:
sudo apt update
sudo apt install nodejs npm
使用npm全局安装Swagger Editor和Swagger UI:
sudo npm install -g swagger-editornpm install -g swagger-ui
Swagger Editor:
Swagger UI:
swaggerConfig.java
):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.yourpackage")) // 替换为你的控制器包路径
.paths(PathSelectors.any())
.build();
}
}
如果你希望更方便地管理和部署Swagger,可以使用Docker:
sudo apt update
sudo apt install docker.io
docker pull swaggerapi/swagger-ui-express
docker run -p 8080:8080 swaggerapi/swagger-ui-express
通过以上步骤,你就可以在Ubuntu上成功安装和配置Swagger,并进行API文档的生成和测试。