还担心接口乱糟糟？快来试试“斯瓦格”在线文档管理平台！

比眉伴天荒 2024-03-23 19:05 30阅读 0赞

在开发过程中，前后端最糟心的事就是沟通接口，在此过程中，吵得最凶的根源就在于接口文档的不完善、乱、难于使用，甚至都没有统一管理接口的地方。本文将分享一款在线接口文档管理工具：“斯瓦格”，同时我将用华为AppCloud进行搭建，每一步都会记录下来，如果你想了解一下“斯瓦格”和AppCloud搭建过程，希望你好好看看本文，让我们直接开始。

### 一、什么是“斯瓦格”？ ###

“斯瓦格”从本质上来讲是定义API（应用程序编程接口）结构的方式，它的核心就是“**规范**”二字，“斯瓦格”规范了如何定义参数、路径是什么样子的、响应应该怎么写、模型如何建立等。

“斯瓦格”支持多种数据格式，比如json、txt、xml、html，也支持多种接口类型，比如HTTP、WebSocket等。

“斯瓦格”那么强大，都有哪些好处呢？

1.  有了“斯瓦格”，接口变得十分规范，阅读起来非常方便；
2.  生成测试文档非常方便，不需要手动一个接口一个接口去写，节省了大量的时间；
3.  可以在线导出不同格式的文档，满足多种场景需求；
4.  支持绝大数主流语言，兼容性强大。

### 二、搭建“斯瓦格” ###

#### 2.1 在AppBazaar购买“斯瓦格”应用 ####

我们会基于华为云AppCloud进行搭建，首先访问AppBazaar的官网`https://console.huaweicloud.com/appbazaar`：

![202211041425615.png][]

> 在开始之前，必须保证你注册了华为云的账号且开通了实名认证。

找到“AppCloud搭建“斯瓦格”在线文档管理平台”，点击进入：

![202211041427234.png][]

在此页面，你可以简单了解一下“斯瓦格”基本知识、所用技术、支持的环境以及“斯瓦格”的预览图。

下一步，点击【立即购买】：

![202211041428578.png][]

勾选【我已阅读并同意 《华为云商城通用商品用户协议》】，然后点击【提交订单】按钮：

![202211041429635.png][]

支付0元后，你就会在【订单管理】界面看到你刚刚购买的“斯瓦格”应用：

![202211041431811.png][]

#### 2.2 构建“斯瓦格”应用 ####

在在【订单管理】界面，点击“AppCloud搭建“斯瓦格”在线文档管理平台”的【去构建应用】按钮：

![202211041433310.png][]

在“01 创建应用”步骤中填写应用的基础信息：

*  应用名称：wljlsmz-“斯瓦格”在线文档管理平台
 *  关联华为云DevCloud：在华为云DevCloud中同步创建新项目
 *  应用简介：用于在线接口管理
 *  选择方案：AppCloud搭建“斯瓦格”在线文档管理平台

![202211041436658.png][]

点击下一步，会看到提示“AppCloud目前只面向【北京四区域】提供服务，您在北京四区尚未开通华为云DevCloud服务，请开通后重试。”：

![202211041437043.png][]

> 根据自己的实际情况来，我这边确实没有开通。

点击【前往开通】：

![202211041438039.png][]

勾选【我已经阅读并同意以上使用声明】，点击【确定】按钮。

在此页面，我们选择“基础版”，点击【免费开通】按钮：

![202211041440109.png][]

配置全部默认，勾选【我已经阅读并同意 《软件开发服务使用声明》】，然后点击【下一步】按钮：

![202211041441634.png][]

点击【去支付】：

![202211041442211.png][]

点击【确认付款】：

![202211041443421.png][]

看到此提示就代表支付成功：

![202211041443551.png][]

然后我们再回到“斯瓦格”创建应用的界面，再次点击【下一步】按钮：

![202211041445072.png][]

可以看到已经成功进入“02 基础配置”页签。

在此界面，我们需要根据提示操作三步：

1.  下载“斯瓦格”软件包

![202211041447287.png][]

下载到本地后，我们就看到了“siwage-2.1.5.war”文件，该文件就是“斯瓦格”的部署包，下一步我们就需要把这个包传到华为云中：

![202211041448930.png][]

1.  去华为云DevCloud“发布”上传“斯瓦格”软件包

![202211041450028.png][]

点击【立即前往】，然后点击【上传】按钮：

![202211041451233.png][]

选择第一步下载的“siwage-2.1.5.war”包，在页面右下角可以看到上传进度：

![202211041452093.png][]

上传成功后就可以在软件发布库列表看到我们刚刚上传的部署包：

![202211041453268.png][]

然后我们再回到“02 基础配置”页面。

1.  选择上传的“斯瓦格”软件包

![202211041454962.png][]

在此步骤，就可以刷新下拉到我们刚刚在华为云DevCloud上传的“斯瓦格”软件包：

![202211041455318.png][]![202211041456796.png][]

选择好包后，我们下面开始进行主机配置，我们填写好“云服务器名称”和“ECS密码”后，点击【开始执行】按钮：

![202211041519199.png][]

点击【确认执行】按钮：

![202211041519367.png][]

然后就会进入“03 一键部署”页签：

![202211041539155.png][]

此过程会经历5个步骤：

*  购买ECS
 *  创建主机组
 *  创建主机
 *  模板创建部署任务
 *  执行部署任务

此过程需要等待5-10分钟左右的时间。

当我们看到部署的5个步骤全部完成时，会提示“部署成功”，这个时候，点击【下一步】：

![202211041548930.png][]

在此，我们看到“斯瓦格”已经部署完毕了，可以访问了。

![202211041549901.png][]

> 友情提醒：如果你只是搭建体验，并不想立即应用的生产或者开发环境的，一定要注意，体验完毕及时释放资源，否则可能一直产生计费。

我们在此点击【打开应用】按钮：

![202211041552896.png][]

至此部署就完成了。

### 三、资源管理 ###

访问页面`https://console.huaweicloud.com/appcloud/myapp`，就可以进入“我的应用”页面：

![202211041609120.png][]

在此页面，我们看到刚刚部署成功的“斯瓦格”在线文档管理平台，因为我也是体验为主，所以我需要及时释放资源，点击【释放资源】按钮即可：

![202211041610633.png][]

释放的过程中，会提示“资源释放中”：

![202211041611585.png][]![202211041611921.png][]

此过程跟部署一样，需要等待一会。

释放完成后，会提示“释放完成”：

![202211041614167.png][]

我们再去看“我的应用”界面的时候，就发现该应用显示的就是“未部署”的状态：

![202211041635932.png][]

如果你想要删除此应用，直接点击【删除应用】的按钮即可，在此我们不删除了。

### 四、总结 ###

从总体的部署过程来说，还是相对比较简单的，基本上没有很复杂的步骤，只是有些前置条件，如果你之前没玩过，可能第一次需要开通一下。本文使用AppCloud搭建“斯瓦格”在线文档管理平台，步骤写的非常详细，截图也是每一步都截了，我相信只要你按照我的步骤一步一步来，基本上不会出问题，最后感谢您的阅读，如果有任何问题，欢迎在下方评论区与我讨论。

[202211041425615.png]: https://img.wljslmz.cn/wljslmzcn/202211041425615.png
[202211041427234.png]: https://img.wljslmz.cn/wljslmzcn/202211041427234.png
[202211041428578.png]: https://img.wljslmz.cn/wljslmzcn/202211041428578.png
[202211041429635.png]: https://img.wljslmz.cn/wljslmzcn/202211041429635.png
[202211041431811.png]: https://img.wljslmz.cn/wljslmzcn/202211041431811.png
[202211041433310.png]: https://img.wljslmz.cn/wljslmzcn/202211041433310.png
[202211041436658.png]: https://img.wljslmz.cn/wljslmzcn/202211041436658.png
[202211041437043.png]: https://img.wljslmz.cn/wljslmzcn/202211041437043.png
[202211041438039.png]: https://img.wljslmz.cn/wljslmzcn/202211041438039.png
[202211041440109.png]: https://img.wljslmz.cn/wljslmzcn/202211041440109.png
[202211041441634.png]: https://img.wljslmz.cn/wljslmzcn/202211041441634.png
[202211041442211.png]: https://img.wljslmz.cn/wljslmzcn/202211041442211.png
[202211041443421.png]: https://img.wljslmz.cn/wljslmzcn/202211041443421.png
[202211041443551.png]: https://img.wljslmz.cn/wljslmzcn/202211041443551.png
[202211041445072.png]: https://img.wljslmz.cn/wljslmzcn/202211041445072.png
[202211041447287.png]: https://img.wljslmz.cn/wljslmzcn/202211041447287.png
[202211041448930.png]: https://img.wljslmz.cn/wljslmzcn/202211041448930.png
[202211041450028.png]: https://img.wljslmz.cn/wljslmzcn/202211041450028.png
[202211041451233.png]: https://img.wljslmz.cn/wljslmzcn/202211041451233.png
[202211041452093.png]: https://img.wljslmz.cn/wljslmzcn/202211041452093.png
[202211041453268.png]: https://img.wljslmz.cn/wljslmzcn/202211041453268.png
[202211041454962.png]: https://img.wljslmz.cn/wljslmzcn/202211041454962.png
[202211041455318.png]: https://img.wljslmz.cn/wljslmzcn/202211041455318.png
[202211041456796.png]: https://img.wljslmz.cn/wljslmzcn/202211041456796.png
[202211041519199.png]: https://img.wljslmz.cn/wljslmzcn/202211041519199.png
[202211041519367.png]: https://img.wljslmz.cn/wljslmzcn/202211041519367.png
[202211041539155.png]: https://img.wljslmz.cn/wljslmzcn/202211041539155.png
[202211041548930.png]: https://img.wljslmz.cn/wljslmzcn/202211041548930.png
[202211041549901.png]: https://img.wljslmz.cn/wljslmzcn/202211041549901.png
[202211041552896.png]: https://img.wljslmz.cn/wljslmzcn/202211041552896.png
[202211041609120.png]: https://img.wljslmz.cn/wljslmzcn/202211041609120.png
[202211041610633.png]: https://img.wljslmz.cn/wljslmzcn/202211041610633.png
[202211041611585.png]: https://img.wljslmz.cn/wljslmzcn/202211041611585.png
[202211041611921.png]: https://img.wljslmz.cn/wljslmzcn/202211041611921.png
[202211041614167.png]: https://img.wljslmz.cn/wljslmzcn/202211041614167.png
[202211041635932.png]: https://img.wljslmz.cn/wljslmzcn/202211041635932.png