关闭

[置顶] Swagger-Editor开发环境搭建

标签: nodejs百度语言Swagger
1613人阅读 评论(0) 收藏 举报
分类:

前言

        上一篇文章我们有提到Swagger做接口的定义是采用yaml语言的,当然,yaml是个啥,大家自行百度。阿福在此不做赘述了。但是,今天我们要来讲的是yaml支持比较好的Swagger-Editor开发环境的搭建。


环境准备

        实际上,Swagger-Editor是基于 NodeJs 开发的,那么,就一定是需要Node的开发环境的啦!安装最新版的Node。直接去到NodeJs中文网,毕竟翻墙的梯子不是每个人都有,而且就算你有,呵呵,拖一个东西下来也不容易啊。链接如下:

NodeJs中文网

        下载最新版的开发环境即可,当然,这里的话你安装之后会顺便把npm安装上给你。npm是什么?这个暂时不操心,可以理解为maven一类的包管理工具。安装好后,测试下,* node -v*,你会看到当前的版本!看到了的话,恭喜你!
        好了下面环境准备好了,让我们进入正式流程撒!


下载 安装

        这个时候,我们需要从Github上clone最新的nodejs的包。指令如下:

git clone https://github.com/swagger-api/swagger-editor.git

        接下来,只需要温柔的进入到Swagger-Editor的目录里面。你就会看到如下的一个目录。


ed


        好了,我们来简单的看一下这里面都有啥?
dist里面毫无疑问放置的是一些静态的文件了,然后那个node_models放置的是你在package.json中定义的那些类库。我们只要看一下README.md就可以知道如何用了。下面,我们看看怎么去开始?
        首先,* npm install *去安装需要的modules,这将会把所有依赖的包安装上,当然,会有些许的warning,这里要记住,一定下载最新版的NodeJs啊。
        在很多别的教程里,会让我们在装上http-server,但是你仔细一点的话就会发现,在packge.json里面实际上是声明了http-server的啦。
好了,现在就可以启动了!
        退回到上一级目录,然后http-server 目录,直接就可以看到下面的信息!


Starting up http-server, serving swagger-editor-master
Available on:
  http://192.168.253.1:8080
  http://172.18.33.1:8080
  http://127.0.0.1:8080
Hit CTRL-C to stop the server

        接下来,访问那个Url,就可以看到美好得画面了!wd


        好了,接下来就可以尽情的使用了,实际上这个编辑器是有线上的版本的,但是苦于网速实在是好坑啊!本地有一个还是比较好的。啊哈哈哈


总结

        本文主要讲述了Swagger-Editor的本地安装,当然,阿福在这里实际上有句话要说,因为觉得不体系化的去写一下Swaager实在是有违天理。于是,后面的文章会按照我接下来放出的一张思维导图!


wd


        期待!也希望能带给大家收获!

0
0

查看评论
* 以上用户言论只代表其个人观点,不代表CSDN网站的观点或立场
    个人资料
    • 访问:92795次
    • 积分:1927
    • 等级:
    • 排名:千里之外
    • 原创:99篇
    • 转载:8篇
    • 译文:1篇
    • 评论:41条