Swagger是一个流行的API文档和交互式测试工具， 它可以帮助开发者轻松地创建、测试和文档化API。在Ubuntu上集成Swagger是一个常见的需求，本文将详细介绍如何在Ubuntu上顺利集成Swagger。

创建Swagger文档

先说说 您需要在项目目录中创建一个名为swagger.yaml的文件，并添加您的API的Swagger规范。比方说：

yaml swagger: '2.0' info: title: Sample API description: A sample API to demonstrate Swagger UI on Ubuntu version: '1.0.0' host: localhost:3000 basePath: / schemes: - http paths: /users: get: summary: List all users responses: 200: description: An array of users

配置Swagger

接下来您需要创建一个Java类来配置Swagger。

java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket;

@Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api { return new Docket .select .apis) .paths) .build; } }

拉取Swagger UI Docker镜像

您可以使用Docker来运行Swagger UI。先说说 拉取Swagger UI Docker镜像：

bash docker pull swaggerapi/swagger-ui-express

运行Swagger UI容器

访问Swagger UI

打开浏览器并访问http://localhost:8080你应该能看到Swagger UI界面。

使用Swagger Editor

如果您想使用Swagger Editor来编辑Swagger文档， 可以按照以下步骤操作：

1. 克隆Swagger Editor仓库：

bash git clone https://github.com/swagger-api/swagger-editor.git

2. 在项目的package.json文件中添加以下依赖：

json { "dependencies": { "swagger-editor": "^3.23.0" } }

3. 运行Swagger Editor：

bash npm install npm run dev

现在您可以在浏览器中访问http://localhost:8080/swagger-editor来编辑Swagger文档。

您的API文档。Swagger是一个强大的工具，可以帮助您提高API开发效率，并确保API的质量。

---