[转] 超高效！Swagger-Yapi的秘密

2022-08-27 18:34:21 阅读：272 来源： 互联网

原文：https://juejin.cn/post/7116729520681549854

导读：相信无论是前端还是后端开发，都或多或少地被接口文档折磨过。前端经常抱怨后端给的接口文档与实际情况不一致。后端又觉得编写及维护接口文档会耗费不少精力，经常来不及更新。其实无论是前端调用后端，还是后端调用后端，都期望有一个好的接口文档。但是随着时间推移，版本迭代，接口文档往往很容易就跟不上代码了,更会出现之前的同学没有把接口文档交接清楚就离职，留下一个繁重复杂的项目，重新啃起来异常艰难，不亚于自己从头写一遍。因此仅仅只通过强制来规范大家是不够的。我们研究了Swagger到Yapi的打通方法。有了它之后，我们可以做到每次写完代码，只需要顺便修改注释，然后提交，Yapi上就能自动更改我们的接口文档
作者：百度Geek说
链接：https://juejin.cn/post/7116729520681549854
来源：稀土掘金
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。 --------------------------------------------------------------------------------------------- 也可以自己更加yapi的openapi，自己写个程序，调用import_data接口。来讲swagger.json自动导入到yapi中。 https://hellosean1025.github.io/yapi/openapi.html

------------------------------

四、Swagger-Yapi

Yapi一个高效、易用、功能强大的API管理平台。

为什么要打通Swagger到Yapi呢？理由很简单。Swagger的SwaggerUI远没有Yapi功能全面，而Yapi能支持导入Swagger.json格式的接口文档，Swagger的便利性和Yapi的全面性，我们把二者结合，从而实现更优的结果。

4.1►Nginx搭建

经过上面的步骤我们应该已经在本地生成了我们接口的Swagger.json，而Yapi已经支持了手动导入和自动导入两种方式。

手动导入：

自动导入：

我们需要的是什么？我们需要的是每次Swagger更新之后，Yapi都会自动更新我们的接口，那么我们自然需要使用Yapi的自动导入，因此我们只需要在自己的机器上搭建一个Nginx来做静态文件代理，就能实现。

下载并安装nginx：

sudo yum install nginx -y
复制代码

安装完成后查看：

rpm -qa | grep nginx
复制代码

启动nginx

sudo systemctl start nginx
复制代码

或是

sudo service nginx start
复制代码

查看nginx状态

sudo systemctl status nginx
复制代码

或是

sudo service nginx status
复制代码

4.2►代理文件

进入nginx目录

cd /etc/nginx/
复制代码

在conf.d目录下新增需要代理的端口

data映射的目录根据自己的实际情况，即swagger.json所在目录的位置而定。

cd conf.d/
vim yapi.conf
复制代码

server {
    listen       8888;
    server_name  localhost;

    location /data/ {
       alias '/home/work/Swagger/swagger-yapi/swagger-json/';
    }
}
复制代码

重启nginx

sudo systemctl restart nginx
复制代码

或

sudo service nginx restart
复制代码

4.3►Yapi自动同步

ip对应你自己的机器ip。

ip地址可以通过以下命令查看：

hostname -i
复制代码

如果被提示了：

说明路径不对，可以把地址输入浏览器访问，自己调整到正确即可。

五、结语

Swagger还有很多的用法，光是通过swagger -h命令就能看到很多用法，而它的注释的用法也有很多，针对不同语言也有不同的写法。同理，Yapi作为一款功能强大的API管理平台也是一样的有很多的用法，比如在线mock接口等等。本文仅作为一个快速上手入门swagger到yapi的方法，通道搭建好之后，更多的用法就可以各位同学自己去挖掘。

作者：百度Geek说
链接：https://juejin.cn/post/7116729520681549854
来源：稀土掘金
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

标签：高效,Yapi,代码,接口,nginx,复制,Swagger
来源： https://www.cnblogs.com/oxspirt/p/16631099.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9

[转] 超高效！Swagger-Yapi的秘密

四、Swagger-Yapi

五、结语