【经验贴】swagger-editor的使用方法

写在前面:对于前后端分离的项目,前端展示需要调用后台提供的数据,后台将数据封装成接口服务提供给前端。前后端分离的妙处不言而喻,使得前后端开发人员更加专注自己的方向。于是前后端开发人员需要商定好api(应用程序接口)数据接口的表现形式,定义好数据接口之后需要向前端开发人员提供api文档,这样前端人员可以根据api文档调用数据,然后通过前端手段使得数据可视化。因此,如何使得api文档更规范是后端人员一直努力的目标,swagger提供了更好的解决方案。下面介绍swagger-editor以及swagger-ui两种api工具。

l swagger-editor的下载与使用方案

1、 由于下载swagger工具可能会不稳定,给出大家专属的下载方式,微信公众号搜索关注技术上的那点事,回复swagger即可获得下载链接,永久有效哦。

2、 下载成功之后,文件夹中包含两个安装文件压缩包,分别为swagger-editor-3.2.0.zip和swagger-editor-master.zip,笔者亲测swagger-editor-3.2.0.zip解压缩之后安装依赖并且启动之后会出现页面访问不到的问题,在此写出来避免各位同仁们踩坑,如果有兴趣探索的朋友可以按照下面的步骤启动第一个压缩文件哦。在此建议大家解压第二个压缩包哦!笔者亲测可以正常使用哦~

【经验贴】swagger-editor的使用方法_第1张图片

swagger-editor压缩包

3、解压之后得到一个安装文件,我们可以利用dos窗口或者使用VS Code软件打开这个安装文件。

进入dos窗口的方法:进入swagger-editor-master文件夹,然后按住shift键,右键鼠标从菜单栏里选择在此处打开命令窗口即可进入dos。(此处建议使用VS Code软件打开安装

你可能感兴趣的:(swagger-editor,ssm框架,api)