swagger页面不显示_Swagger原理简介

Swagger的官网上有一个在线的demo，可以在线体验。我们也可以下载其源码，执行distindex.html文件，即可得到和官网一样功能的demo，不需要架设服务器就能使用。

从网络请求中查看，发现它请求了一个名为swagger.json的文件。

而这个json文件里面定义的基本就是文档的scheme。从这个页面我们基本上可以发现swagger的原理了：

swagger依赖一个基于openapi规范的json文档，它定义了接口scheme。
页面加载后，会获取指定的接口的scheme，然后生成接口页面。
点击执行后，会通过浏览器发送ajax请求，然后将结果呈现在界面上，从而实现接口测试。

简单的来讲，swagger接口测试是一个纯前端的实现，不需要后台支持。它就是一个在线版的postman，实际上，postman也支持openapi规范，通过导入scheme后，也可以实现一样的功能。不过，和postman相比，swagger具有如下优势：

不需要本地客户端
可以和应用集成，不需要手动导入接口定义
通过浏览器发送的ajax请求，往往可自动基础了用户的身份信息，测试带权限控制的接口非常方便。

在.net core中，要将swaggerui和站点集成，需要进行如下几步：

根据ApiExplore生成接口文档内容
注册路由，提供接口文档的下载地址
将swaggerui页面集成到站点中
将路由路径设置到swagger页面中

简单的来讲就两步，提供接口文档下载url和集成swaggerui。当前.net core已经有了一些开源实现，如： swashbuckle 和 nswag 。对于大多数的场景来说，直接使用它们是非常方便的。

然而，有的时候我们是需要一些高级的功能的，如分布式的服务需要提供一个集中的api页面，或者需要对页面进行一些定制(如分组，权限控制，样式调整等)。虽然这些库也提供了一定的支持，但往往不够灵活。一个简单的方案是：只利用这些库来生成swagger接口文档swagger.json，在官方的静态页面基础上自己定制UI，这样要灵活的多。

swagger页面不显示_Swagger原理简介相关推荐

swagger页面不显示_Swagger字段属性说明不显示
不管是在SwaggerBootstrapUi以前的版本中,还是在SwaggerBootstrapUi的1.8.9版本发布新功能字段注释逐行显示时,很多朋友都会问为啥自己的UI文档上不显示注释. 1.8 ...
SpringBoot之整合Swagger(页面无法显示)
问题: 配置Swagger后,访问http://localhost:8080/swagger-ui.html不显示页面原因:Swagger版本过高我尝试降低springboot版本到2.2.6.R ...
轻量级日志系统Loki原理简介和使用
前言这篇文章应朋友的要求,让写一篇loki日志系统,咱定义不容辞一定要好好写开干! 现实中的需求公司的容器云运行的应用或某一个节点出现了问题,解决的思路问题首先被prometheus监控 1 ...
[html] 如何在页面上显示Emoji表情？
[html] 如何在页面上显示Emoji表情? 如果客户端发送了一个带条件的GET 请求且该请求已被允许,而文档的内容(自上次访问以来或者根据请求的条件)并没有改变,则服务器应当返回这个304状态码. ...
CAS单点登陆原理简介及环境搭建
前言最近这几天在研究CAS 今天终于在本地部署成功了今天写一篇文章记录下原理简介 SSO单点登录在多个相互信任的系统中,用户只需要登录一次就可以访问其他受信任的系统. 新浪微博与新浪博客是相互 ...
linux设备驱动程序架构的研究,Linux设备驱动程序学习（12）-Linux设备模型（底层原理简介）...
Linux设备驱动程序学习(12) -Linux设备模型(底层原理简介) 以<LDD3>的说法:Linux设备模型这部分内容可以认为是高级教材,对于多数程序作者来说是不必要的.但是我个人认 ...
oracle bam教程,Oracle BAM原理简介
Oracle BAM原理简介 Oracle BAM全称为Oracle Busines Activity Monitoring,中文叫Oracle 业务活动监视 ,BAM有两种功能 1.创建实时repo ...
Linux安全原理简介
Linux安全原理简介介绍在设置Linux计算机的所有阶段,安全性应是首要考虑之一.要在计算机上实施良好的安全策略,需要对Linux的基础知识以及所使用的某些应用程序和协议有充分的了解. Linu ...
飞机飞行速度测量的原理简介
原文地址:飞机飞行速度测量的原理简介作者:stdhj 在飞机的前边安装有一个叫空速管的管子,也叫皮托管,总压管,风向标气流方向传感器或流向角感应器,当飞机向前飞行时,气流便冲进空速管,在管子末端的感 ...

swagger页面不显示_Swagger原理简介

swagger页面不显示_Swagger原理简介相关推荐

最新文章

热门文章