当前位置: 首页 > 网络应用技术

使用Clia Swagger Generator在VSCODE中的Rust Web界面创建文档

时间:2023-03-06 01:16:08 网络应用技术

  这是一个提高工作效率的Vscode插头。它可以从Rust开发的背景接口中生成Swagger文档,然后可以将其导入YAPI以快速创建接口文档。

  为什么我们要开发此Vscode插头?可以开发哪些好处?

  当我们开发背景接口时,通常首先定义此接口。在审查了开发团队中界面的描述之后,前端开发人员获得了一致的意见,然后执行了接口的实际程序开发。

  一方面,开发开发的界面方向将不会是错误的,另一方面,前端开发人员还可以尽快开始开发界面描述的开发工作。

  这需要我们的文档首先写入接口的描述文档。

  过去,我们所有人都直接在YAPI上进行了接口文档工作,然后开发了接口开发。

  但是,感觉接口文档直接写在YAPI上,这不是很高效。并且该文档已经编写,然后制作了力量,然后遵循接口文档开发的程序。这是第二次。您可以将这两种力量合并为一支力量吗?

  因此,我们认为接口是直接在程序中定义的,然后接口文档是直接从程序中生成的。

  这样做有几个好处:

  插头的演示

  直接在Vscode Plug -in中搜索CLIA,您应该看到插头-IN“ Clia Swagger Generator”。

  只需安装即可。

  在插头的扩展中,需要填写三个项目。

  合适的锈接口是什么样的?

  以下生锈代码:

  以上是一个实际的Rust接口程序。

  需要注意以下几点:

  接口定义中的Swagger文档

  接口定义下方有一个“生成招牌”按钮。如果单击,您将在右侧生成Swagger文档。

  单击文档上的“保存Swagger.json”按钮以保存文档,并在保存时自动添加时间戳。

  在最后一步中,生成的宣传文件被进口到YAPI中。

  在YAPI的数据管理中,选择要导入的Swagger格式和目录,然后将刚刚生成的Swagger文档拖到上传区域。

  生成接口文档。

  清单很重要

  仓库地址:https://github.com/clia/swagger-tenerator

  原始:https://juejin.cn/post/7100010294360932383