Swagger-editor教程
学习⽬标:为什么要使⽤Swagger?
Swagger 是⼀款RESTFUL接⼝的⽂档在线⾃动⽣成+功能测试功能软件
随着互联⽹的发展,现在的软件架构已经由原来的jsp渲染页⾯变为了现在的前后端完全分离,前端只做前端的事,后端只做后端的事,⽽不是在后端开发中要将前端⼈员写好的页⾯改为jsp。如果页⾯出什么问题还需要前端开发⼈员懂得⼀定的jsp语法才能进⾏调试。
所以,在前后端完全分离的情况下,前后端⼈员唯⼀的联系就变成了API接⼝,写API接⼝的⽅式有很多种,可以使⽤word来编写,也可以使⽤markdown来编写,但Swagger来编写是更好也是更优雅的⽅式,swagger就是能够让你更好的编写API⽂档的框架
swagger的下载与安装
1. 下载swagger,并解压
下载地址github/swagger-api/swagger-editor
2. 由于swagger是使⽤Angular开发的⼀款BS软件,所以此处需要全局安装http-server,需要nodejs环境,
在命令⾏中运⾏以下命令
npm i http-server -g
3. 在swagger-editor的⽬录外执⾏命令
http-server swagger-editor
注意,⼀定要在⽬录外运⾏,⽐如我的解压⽬录是
那么就在运⾏
jsp用什么前端框架http-server后⾯跟的是⽬录名,然后使⽤⽣成的这⼏个⽹址都可以访问,如果出现访问不了,请在后⾯加上/index.html,或者将⽬录扔到tomcat下运⾏,如果出现以下界⾯就表⽰安装运⾏成功了
swagger-editor基本界⾯基本介绍
swagger-editor⼤致可以分为三部分
1. 基础信息
2. path(核⼼部分),API的具体描述、路径、返回值,参数,请求格式
3. path以下部分,描述返回的类型,字段,安全信息
⽰例:
如若有描述不对的地⽅,欢迎指正,谢谢
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论