Swagger简介

Swagger是一个用于构建、测试和文档化RESTful API的有力巨大工具。它能帮开发者创建API文档，给在线测试接口，并且能轻巧松集成到开发周围中。

搭建Swagger测试周围前的准备干活

在Debian系统上搭建Swagger测试周围，先说说需要确保系统中安装了Node.js和npm。

bash sudo apt update sudo apt install nodejs npm

安装完成后 能通过以下命令检查Node.js和npm的版本：

bash node -v npm -v

安装Swagger UI

用npm安装Swagger UI Express，这是一个能在Express应用中集成Swagger UI的库。

bash npm install swagger-ui-express

创建Express应用

创建一个新鲜的目录来存放你的Swagger项目，并在该目录中初始化一个新鲜的项目。

bash mkdir swagger-project cd swagger-project npm init -y

创建一个名为app.js的文件， 并添加以下代码来创建一个轻巧松的Express服务器：

javascript const express = require; const swaggerUi = require; const YAML = require; // 加载Swagger文档 const swaggerDocument = YAML.load; const app = express; // 用Swagger UI Express中间件 app.use); const PORT = process.env.PORT || 3000; => { console.log; }));

编写Swagger规范文件

在项目目录中创建一个名为swagger.yaml的文件，并添加你的API规范。

yaml swagger: '2.0' info: title: Sample API description: A sample API to demonstrate Swagger UI on Debian version: '1.0.0' host: localhost:3000 basePath: / schemes: - http paths: /users: get: summary: List all users responses: '200': description: An array of users schema: type: array items: $ref: '#/definitions/User' definitions: User: type: object properties: id: type: integer format: int64 name: type: string format: email email: type: string format: email

运行你的应用

在项目目录中， 用以下命令启动你的Express服务器：

bash node app.js

眼下你能在浏览器中访问http://localhost:3000/api-docs来查看Swagger UI界面并与你的API进行交互。

周围，方便地进行API的测试和文档化。在实际应用中，你能根据需求对Swagger UI进行自定义，以达到更优良的效果。

---