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

雨点打透心脏的1/2处 2023-10-07 20:58 8阅读 0赞

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

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

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

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

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

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

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

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

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

![250339787873f551d276ab32c3645d14.png][]

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

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

![45c7e268b2ba95af53202ec1e336e575.png][]

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

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

![b0d0f464113065b29052755d6bd4aad1.png][]

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

![9dc90c8281908980d153ee5f39d5fc83.png][]

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

![1c7c7839178f2ec2a4143eb65939bbd2.png][]

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

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

![4e1f8338032c760e376d5e0551c7dc7e.png][]

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

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

![ff8966b900d920f61953cd20a3b6beca.png][]

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

![b85ae9ed5733ae90e8f0e9460af0d697.png][]

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

点击【前往开通】：

![17a978d9967da4becc07aef0c670e268.png][]

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

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

![9102bf42c5547920fb28506877f6f117.png][]

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

![97d363edcc7179b39d66ea6d930a32a7.png][]

点击【去支付】：

![afd77492ef0fb28bb7fa9279c3c3b80e.png][]

点击【确认付款】：

![cea1339d88d192f971b7b469959e6a27.png][]

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

![c9da8a060a7d62f909f0454779b43d3b.png][]

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

![0d57c0ac07485fda36d86a74503e2b00.png][]

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

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

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

![a55e988e9a65fdf23cd96d337d4eccbc.png][]

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

![9b0f1aa20521e36a08c60d41bc29d930.png][]

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

![9ecff29c96660ba25aad582dd0d1bbc5.png][]

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

![a068ae6fc544055b026d9c99130ed888.png][]

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

![2ce82469d127370b7d9133bb945691ff.png][]

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

![062c866fdbed02e3aa744bd6c9c9e99c.png][]

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

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

![12733e862070536ac076bcfea6c4566b.png][]

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

![b77125868a821bb9123b00ef0449953d.png][]

![edca955e1d2958d45ab658185fb7f569.png][]

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

![8bae7ed32e00d9e77dee741edc57c52c.png][]

点击【确认执行】按钮：

![cf78fbe220e3e8e267bbbb8e062a1adc.png][]

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

![5de0041c577e9802b52bad8e54e40d1b.png][]

此过程会经历5个步骤：

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

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

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

![16920d0fa475f7994eff6df1390ef970.png][]

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

![22f2c4fbd6a127384d83e4dadaad2d58.png][]

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

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

![311aa0329d3a25403142b428afc076fe.png][]

至此部署就完成了。

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

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

![e36935b03425abbf584eb9efaacce4d4.png][]

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

![44915d60c06298a4814466e3dcbe93dc.png][]

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

![a195e40b34a831844c0a2d16d8f02e7c.png][]

![4f8ae264ba7fa7e4dbd8633e307957ee.png][]

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

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

![53e6bc2fce6445ca4b75d27896e645f8.png][]

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

![765f423d253dd4a28278e65265c99634.png][]

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

### 四、总结 ###

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

[250339787873f551d276ab32c3645d14.png]: https://img-blog.csdnimg.cn/img_convert/250339787873f551d276ab32c3645d14.png
[45c7e268b2ba95af53202ec1e336e575.png]: https://img-blog.csdnimg.cn/img_convert/45c7e268b2ba95af53202ec1e336e575.png
[b0d0f464113065b29052755d6bd4aad1.png]: https://img-blog.csdnimg.cn/img_convert/b0d0f464113065b29052755d6bd4aad1.png
[9dc90c8281908980d153ee5f39d5fc83.png]: https://img-blog.csdnimg.cn/img_convert/9dc90c8281908980d153ee5f39d5fc83.png
[1c7c7839178f2ec2a4143eb65939bbd2.png]: https://img-blog.csdnimg.cn/img_convert/1c7c7839178f2ec2a4143eb65939bbd2.png
[4e1f8338032c760e376d5e0551c7dc7e.png]: https://img-blog.csdnimg.cn/img_convert/4e1f8338032c760e376d5e0551c7dc7e.png
[ff8966b900d920f61953cd20a3b6beca.png]: https://img-blog.csdnimg.cn/img_convert/ff8966b900d920f61953cd20a3b6beca.png
[b85ae9ed5733ae90e8f0e9460af0d697.png]: https://img-blog.csdnimg.cn/img_convert/b85ae9ed5733ae90e8f0e9460af0d697.png
[17a978d9967da4becc07aef0c670e268.png]: https://img-blog.csdnimg.cn/img_convert/17a978d9967da4becc07aef0c670e268.png
[9102bf42c5547920fb28506877f6f117.png]: https://img-blog.csdnimg.cn/img_convert/9102bf42c5547920fb28506877f6f117.png
[97d363edcc7179b39d66ea6d930a32a7.png]: https://img-blog.csdnimg.cn/img_convert/97d363edcc7179b39d66ea6d930a32a7.png
[afd77492ef0fb28bb7fa9279c3c3b80e.png]: https://img-blog.csdnimg.cn/img_convert/afd77492ef0fb28bb7fa9279c3c3b80e.png
[cea1339d88d192f971b7b469959e6a27.png]: https://img-blog.csdnimg.cn/img_convert/cea1339d88d192f971b7b469959e6a27.png
[c9da8a060a7d62f909f0454779b43d3b.png]: https://img-blog.csdnimg.cn/img_convert/c9da8a060a7d62f909f0454779b43d3b.png
[0d57c0ac07485fda36d86a74503e2b00.png]: https://img-blog.csdnimg.cn/img_convert/0d57c0ac07485fda36d86a74503e2b00.png
[a55e988e9a65fdf23cd96d337d4eccbc.png]: https://img-blog.csdnimg.cn/img_convert/a55e988e9a65fdf23cd96d337d4eccbc.png
[9b0f1aa20521e36a08c60d41bc29d930.png]: https://img-blog.csdnimg.cn/img_convert/9b0f1aa20521e36a08c60d41bc29d930.png
[9ecff29c96660ba25aad582dd0d1bbc5.png]: https://img-blog.csdnimg.cn/img_convert/9ecff29c96660ba25aad582dd0d1bbc5.png
[a068ae6fc544055b026d9c99130ed888.png]: https://img-blog.csdnimg.cn/img_convert/a068ae6fc544055b026d9c99130ed888.png
[2ce82469d127370b7d9133bb945691ff.png]: https://img-blog.csdnimg.cn/img_convert/2ce82469d127370b7d9133bb945691ff.png
[062c866fdbed02e3aa744bd6c9c9e99c.png]: https://img-blog.csdnimg.cn/img_convert/062c866fdbed02e3aa744bd6c9c9e99c.png
[12733e862070536ac076bcfea6c4566b.png]: https://img-blog.csdnimg.cn/img_convert/12733e862070536ac076bcfea6c4566b.png
[b77125868a821bb9123b00ef0449953d.png]: https://img-blog.csdnimg.cn/img_convert/b77125868a821bb9123b00ef0449953d.png
[edca955e1d2958d45ab658185fb7f569.png]: https://img-blog.csdnimg.cn/img_convert/edca955e1d2958d45ab658185fb7f569.png
[8bae7ed32e00d9e77dee741edc57c52c.png]: https://img-blog.csdnimg.cn/img_convert/8bae7ed32e00d9e77dee741edc57c52c.png
[cf78fbe220e3e8e267bbbb8e062a1adc.png]: https://img-blog.csdnimg.cn/img_convert/cf78fbe220e3e8e267bbbb8e062a1adc.png
[5de0041c577e9802b52bad8e54e40d1b.png]: https://img-blog.csdnimg.cn/img_convert/5de0041c577e9802b52bad8e54e40d1b.png
[16920d0fa475f7994eff6df1390ef970.png]: https://img-blog.csdnimg.cn/img_convert/16920d0fa475f7994eff6df1390ef970.png
[22f2c4fbd6a127384d83e4dadaad2d58.png]: https://img-blog.csdnimg.cn/img_convert/22f2c4fbd6a127384d83e4dadaad2d58.png
[311aa0329d3a25403142b428afc076fe.png]: https://img-blog.csdnimg.cn/img_convert/311aa0329d3a25403142b428afc076fe.png
[e36935b03425abbf584eb9efaacce4d4.png]: https://img-blog.csdnimg.cn/img_convert/e36935b03425abbf584eb9efaacce4d4.png
[44915d60c06298a4814466e3dcbe93dc.png]: https://img-blog.csdnimg.cn/img_convert/44915d60c06298a4814466e3dcbe93dc.png
[a195e40b34a831844c0a2d16d8f02e7c.png]: https://img-blog.csdnimg.cn/img_convert/a195e40b34a831844c0a2d16d8f02e7c.png
[4f8ae264ba7fa7e4dbd8633e307957ee.png]: https://img-blog.csdnimg.cn/img_convert/4f8ae264ba7fa7e4dbd8633e307957ee.png
[53e6bc2fce6445ca4b75d27896e645f8.png]: https://img-blog.csdnimg.cn/img_convert/53e6bc2fce6445ca4b75d27896e645f8.png
[765f423d253dd4a28278e65265c99634.png]: https://img-blog.csdnimg.cn/img_convert/765f423d253dd4a28278e65265c99634.png