Products
96SEO 2025-09-16 22:55 0
Swagger是一个流行的API框架, 用于描述、生成、测试和文档化RESTful Web服务。在Ubuntu上配置Swagger, 先说说需要创建一个新的Swagger配置文件,然后按照步骤进行配置。
要开始配置Swagger,先说说需要在Ubuntu上安装Swagger命令行工具。
sudo npm install -g swagger-cli
使用Swagger命令行工具创建一个新的Swagger配置文件:
swagger generate-spec -i /path/to/your/api-docs -o /path/to/output/swagger.yaml
这里 -i
参数指定了API文档的路径,-o
参数指定了输出配置文件的路径。
打开创建的swagger.yaml文件, 根据以下示例进行配置:
swagger: '2.0'
info:
title: Sample API
version: '1.0.0'
description: A sample API to illustrate Swagger configuration
host: localhost:8080
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
email:
type: string
format: email
接下来安装并运行Swagger UI,以便在浏览器中查看API文档。
sudo npm install -g swagger-ui-express
swagger-ui-express --specs=/path/to/swagger.yaml --host=localhost:3000
在浏览器中打开以下链接, 即可查看API文档:
人员更好地理解和测试API。
Demand feedback