Swagger UI入门部署

概述:

在开发过程中,通用的功能我们通常会定义一些接口,但随着项目越做越大,时间越来越久,接口就越来越多,忘的就越来越多,沟通成本就越来越高,最后就会想到,当时把定义的接口及用法都写下就好了,巴拉巴拉一大堆后悔的话。

为了解决上述描述的问题,Swagger UI应运而生。

Swagger UI可以让我们把定义的接口以配置文件的方式编写,最后生成一个可视化较高的网站。

Swagger UI有如下优势:

  • 编写语言统一
  • 风格统一
    不会像自己写的word说明文档,各成一家
  • 可读性高
    生成的界面简洁、信息全
  • 可交互
    这是最可贵的,根据查看到的接口,我们不仅能看到接口的链接串、参数、返回值等各种信息,我们还可以真是的对服务器进行请求,查看真实的交互,大大减小了同事之间的交互成本。

资源传送门

官网地址
Demo地址
在线编辑地址

可以把Swagger UI理解成自己部署的一个网站

安装部署

下面介绍下如何部署自己的Swagger UI

1.从git上clone

github上clone:https://github.com/swagger-api/swagger-ui

2.新建一个文件夹public

将下载到的swagger ui里的dist文件夹里的文件复制到public文件夹里

3.在IIS上部署

在运行中inetmgr打开IIS,把public文件夹新建一个网站
如果MIME Types中没有对json的支持,需要添加 .json、application/json

4.访问

在浏览器中输入你配置的网址就可以访问了
http://localhost:8011/index.html

部署自己的接口API

上面的部署的接口来源是从Swagger UI官网提供的,如何部署自己的接口API呢,这需要先编写自己的API代码。
Swagger Editor提供了编写Swagger UI的工具。
大家可以在这里编写自己的Swagger UI,该框架使用的是YAML语言进行编写,不熟悉的朋友可以自行学习下。

步骤:
  • 在Swagger Editor中点击File--->Download JSON
  • 将下载的json文件你的public文件夹下
  • 修改index.html文件,将原来引用官网json文件的链接改成刚生成的json文件的路径
  // Build a system
  const ui = SwaggerUIBundle({
    url: "./swagger.json",
    dom_id: '#swagger-ui',
    presets: [
      SwaggerUIBundle.presets.apis,
      SwaggerUIStandalonePreset
    ],
    plugins: [
      SwaggerUIBundle.plugins.DownloadUrl
    ],
    layout: "StandaloneLayout"
  })

  window.ui = ui
}

在浏览器中访问下,能访问就OK了。

推荐一个基于node部署的链接

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342

推荐阅读更多精彩内容