在 Linux 系统中,要导出 Swagger 文档,你需要遵循以下步骤:
pom.xml
文件中添加以下依赖:<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>
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.any())
.paths(PathSelectors.any())
.build();
}
}
这段代码会启用 Swagger2 并允许所有请求和路径。
启动你的应用程序。确保 Swagger UI 已经成功启动并可以在浏览器中访问。通常,你可以通过访问 http://localhost:8080/swagger-ui.html
来查看 Swagger UI。
导出 Swagger 文档。在 Swagger UI 页面中,点击 “Authorize” 按钮,然后点击 “Download Swagger JSON” 按钮。这将下载一个包含所有 API 信息的 JSON 文件。你也可以选择导出为 YAML 格式,只需点击 “Download Swagger YAML” 按钮即可。
注意:这些步骤适用于基于 Java 的项目。如果你使用的是其他编程语言,导出 Swagger 文档的方法可能会有所不同。