Swagger Editor 的部署使用

最新推荐文章于 2025-09-17 02:35:55 发布

原创

最新推荐文章于 2025-09-17 02:35:55 发布 · 920 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#接口 #swagger2 #编辑器 #yaml

本文档详细介绍了如何在本地部署Swagger Editor，包括安装nodejs和npm，使用http server，下载项目，配置环境变量及启动服务。此外，还讲述了Swagger的使用方法，推荐使用Firefox或Chrome浏览器，并提供了yaml语法参考。

文章目录

一、swagger 本地部署

Swagger Editor 可以使用在线编辑器，也可以离线本地部署环境。使用YAML定义接口规范，接口文档生成不同框架服务端、客户端。可以导出JSON格式API规范，通过Swagger UI发布。

1、安装 nodejs、npm

npm是Nodejs的包管理器

戳node.js官网

戳node.js文档

2、npm 安装 http server

npm install -g http-server

..\npm\下生成http-server、hs

..\npm\node_modules下生成http-server

3、下载项目

Swagger-Editor GitHub项目

4、环境变量

拷贝hs.cmd的绝对路径C:\Users\Administrator\AppData\Roaming\npm（npm安装hs的目录）作为HS_HOME环境变量

5、运行hs服务

命令行 cd 到 Swagger-Editor 项目下载存放目录，运行命令 hs ，默认端口8080；也可指定端口 hs -p 8081；Ctrl+C 可以停止服务运行

二、Swagger 使用

建议使用Firefox/Google Chrome访问 http://127.0.0.1:8080

YAML格式字段，附：yaml语法

swagger: '2.0'                      # swagger版本
info:
  title: 文档标题
  description:  描述
  version: "v1.0"                   # 版本号
  termsOfService: ""                # 服务截止日期
  contact:                          # 联系
    name: ""                        # 姓名
    url: ""                         # URL
    email: ""                       # 邮箱
  license:                          # 授权证书
    name: ""                        # 名称，如Apache 2.0
    url: ""

最低0.47元/天解锁文章