swagger-editor从安装部署到使用

一、安装及启动
1.确定node工具是否安装成功

node -v
npm -v

可以看到node.js安装成功
1.1 安装http-server

npm install -g http-server

报错：

npm ERR! code ETIMEDOUT
npm ERR! errno ETIMEDOUT
npm ERR! network request to https://repo.ctbiyi.com:6643/repository/npmall/ms failed, reason: connect ETIMEDOUT 140.249.193.206:6643

换一下镜像
C:\Users\xu>npm config set registry http://registry.cnpmjs.org
下一步

npm info express

再次执行安装命令，成功了！！：

npm install -g http-server

2.swagger安装包的git地址
https://github.com/swagger-api/swagger-codegen
https://github.com/swagger-api/swagger-editor
https://github.com/swagger-api/swagger-ui
https://github.com/swagger-api
下载后的文件：
swagger-codegen-master.zip
swagger-editor-master.zip
swagger-ui-master.zip

启动node.js时，要查看端口是否已经被占用
启动swagger-editor

   http-server swagger-editor

查了很多资料，后来各种解决方法都无法访问页面

但是找到这个！！
安装anywhere，问题解决

装anywhere！然后在要设置的目录下 运行anywhere!就可以解决了！
anywhere安装命令：npm install -g anywhere
使用：在要启动静态服务的目录下执行

anywhere -p 8080

二、使用Swagger Editor
启动命令之后，打开editor的编辑界面：

1、简介
可以提供语法高亮，自动补全，及时预览等功能
接口信息可以输入url和导入文件的形式
保存的格式支持yaml和json的格式
可以清除编辑的内容

2、支持的服务，java，php，python等

3、支持的客户端包括，安卓，ios等

使用 Swagger 编辑器需要编写 yaml 文件，生成 API 接口文件。只要在给定的 yaml 文件，修改我们需要修改的部分，然后点击上方的 [Generate Server] 即可生成服务端代码， [Generate Client] 可以生成客户端代码，其中的 index.html 打开后是 API 可视化的页面
以编写服务端代码为例，之后需要往其中填充与前端交互的逻辑，以及完成配置数据库等对后端的操作

4、操作步骤
yaml例子
首先通过swagger属性声明openapi规范的版本
info 属性是api的描述信息

path内的相关内容如下：

in 属性指定参数位置
definitions可以用来定义常用的内容，定义完成后，我们可以使用 reference 属性来引用，也就是 $ref

参考原文链接
https://www.cnblogs.com/onelikeone/p/9997429.html
https://blog.csdn.net/qq_43256905/article/details/111579707