自学内容网 自学内容网

ApiChain-从迭代到项目

项目地址:ApiChain 项目主页

当项目上线,版本迭代结束时,可以在 设置->版本迭代->选择迭代->迭代状态 中关闭该迭代,关闭后该迭代不会在左侧的迭代tab下显示,不过可以在 设置->版本迭代->选择迭代->迭代状态 中重新打开它。

Snipaste_2024-11-22_09-58-39.png

当你关闭该迭代时,这个迭代文档中出现的全部接口都将按接口对应的项目合并到该项目的全局接口列表中,按照 请求方式+请求URI 一致的原则进行覆盖,此时该项目的接口文档代表了线上正在运行的项目的最新接口列表和接口规范。所有人可以基于此接口列表的文档了解该项目的全貌。

Snipaste_2024-11-22_10-12-15.png

迭代中编写的单测用例不会在关闭迭代时自动合并到迭代关联的项目中,你可以选择单测用例手动导出到项目中。导出的过程会在该单测涉及的项目下创建一个指向该单测的引用,同时把该迭代使用的所有 仅迭代私有 的环境变量 拷贝为单测环境变量,可以在项目单测中独立修改,仅对该项目单测生效。也就是说,项目单测的本质依然是迭代单测,但引用的环境变量为独立的属于当前单测私有的数据。

Snipaste_2024-11-22_09-57-42.png

如下图所示,项目单测和迭代单测最大的不同就是,项目单测有自己独立的环境变量,这些环境变量仅与当前单测有关,是持久化的。

Snipaste_2024-11-22_10-25-22.png

会员功能

购买会员后,可以使用额外的会员功能,目前会员功能主要有两个:迭代文档 和 mock 服务器

迭代文档

非会员迭代文档仅可本地查看以及导出成markdown、html格式的文件分享。

Snipaste_2024-11-22_10-34-02.png

开通会员后,可以打开迭代文档开关,这个迭代的文档就可以通过 局域网Url 地址的方式在局域网内分享查看,前端或者测试看到的迭代文档就是你在这个迭代编写的最新的接口文档,他们基于此画页面或者测试你的接口正确与否。

Snipaste_2024-11-22_10-38-35.png

点击复制按钮可以得到一个局域网的Url地址,他们打开这个Url地址就可以看到你最新编写的迭代文档啦。

Snipaste_2024-11-22_10-40-56.png

mock服务器

这个功能感觉对于前端非常有用,在并行开发期间,频繁把代码部署到服务器供前端调用显得非常麻烦,前端需要的仅仅是一个能返回他们所需要的正确的数据格式的接口,他们基于这个接口的返回报文构造界面。mock服务器通过给前端提供一个局域网的仅对特定迭代特定项目生效的Url地址前缀,其他内容,如 url地址后面部分,接口调用后的返回报文等,都与接口文档保持一致。

Snipaste_2024-11-22_10-47-39.png

如图所示,在这个迭代下,迭代涉及的每个项目的地址前缀都变成了一个符合文档编写者要求的前缀,调用后返回文档编写者期望的数据返回。


原文地址:https://blog.csdn.net/fanghailiang2016/article/details/143988622

免责声明:本站文章内容转载自网络资源,如本站内容侵犯了原著者的合法权益,可联系本站删除。更多内容请关注自学内容网(zxcms.com)!