前情简介:随着互联网发展,前后端慢慢分离,到最后仅靠API接口联系。于是API文档变成了前后端开发人员联系的纽带,变的越发重要,swagger则是一款可以更好书写API文档的框架。(rap 阿里开发 较轻量)

swagger-ui
用来显示API文档的。不可编辑

swagger-editor
在线编辑文档说明文件的工具,左边编辑,右边显示编辑内容!

编辑swagger说明文件使用的是yaml语法(官网自行查看)
目前最流行的做法,就是在代码注释中写上swagger相关的注释,然后,利用小工具生成swagger.json或者swagger.yaml文件。
swagger-validator
检验生成的文档说明文件是否符合语法规定。
用法:url地址栏,根路径下加上一个参数url(参数内容是swagger说明文件地址),可以检验了!
swagger-codegen
代码生成器,脚手架。可根据swagger.json或swagger.yml文件生成指定的计算机语言指定框架的代码。
网友评论