SwaggerUI--SosoApi

1、SwaggerUI是什么？

Swagger UI是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。

Swagger-UI 的官方地址：http://swagger.io/

Github上的项目地址： https://github.com/swagger-api/swagger-ui

官方提供的demo地址：http://petstore.swagger.io/

2、为什么API接口文档用SwaggerUI？

现在多数的项目开发中，网站和移动端都需要进行数据交互和对接，这少不了使用REST编写API接口这种场景。特别是不同开发小组协作时，就更需要以规范和文档作为标准和协作基础。良好的文档可以减少沟通成本，达到事半功倍的效果。

有时对一些API说明的理解比较模糊，总想着能直接验证一下自己的理解就好了，而不是需要去项目写测试代码来验证自己的想法。即API文档应具备直接执行能力，这种能力类似word,wiki等是无法提供。 SwaggerUI就是这样一种利器，基于html+javascript实现，倾向于在线文档和测试，使用和集成十分简单，能容易地生成不同模块下的API列表，每个API接口描述和参数、请求方法都能定制并直接测试得到直观的响应数据。

体验SwaggerUI最好的方法就是看下官网提供的demo，看过之后相信你一定会兴奋不已。

3、SwaggerUI怎么用？

目前官方提供的SwaggerUI的使用方式主要有2种：

与不同的服务端代码集成: 在服务端代码中嵌入SwaggerUI文档生成代码，部署时自动生成。
手动编辑对应的json文档: 该json文档有其特定格式，相对比较复杂，手动编写难度比较大，可通过官方提供的在线编辑来实现。

4、SwaggerUI有什么弊端？

集成方式

如果是与服务端代码集成，直接嵌入到工程代码中，侵入性比较大，将文档参数和应用参数杂糅在一起，不易阅读，而且比较依赖于项目， 无法独立部署，项目挂掉，文档也无法访问。给后期代码维护增加难度。

如果直接编辑json文档，则难度比较大，即使是官网的在线编辑功能也比较弱，提示功能差劲，很多时候在编辑预览中没问题，导出来部署就显示不正常，而且不支持多人编辑，只能一次一个人改，部署相当不方便。

用户体验

无论请求还是响应无法方便的输入自定义json格式，特别是多层嵌套，异常繁琐。

5、SosoApi如何解决SwaggerUI弊端？

集成方式: SosoApi摈弃直接在服务端代码嵌入方式，推荐编辑json文档。不过，将编辑方式变更为表单提交方式，用户只要动动鼠标，敲敲几个关键字就可以输出一个接口，方便快捷，而且无需学习SwaggerUI相关的json格式，上手简单，减少学习成本。
用户体验: SosoApi支持自定义json格式，可以随意的输入自定义的json，再也不用受到原来文档格式的约束。

6、扩展版SwaggerUI新增了哪些功能？

请求参数数据类型新增"自定义"，允许用户直接输入相关的json格式数据
响应数据类型新增"自定义"，允许用户直接输入相关的json格式数据
国际化支持
bug修复

http://www.sosoapi.com/pass/faq/swagger.htm

转载于:https://www.cnblogs.com/softidea/p/6999596.html

SwaggerUI--SosoApi相关推荐

再见丑陋的 SwaggerUI，这款API文档生成神器界面更炫酷，逼格更高！
欢迎关注方志朋的博客,回复"666"获面试宝典一般在使用 Spring Boot 开发前后端分离项目的时候,都会用到 Swagger.Swagger 是一个规范和完整的框架,用于 ...
颜值绝绝子的swagger-ui
欢迎关注方志朋的博客,回复"666"获面试宝典来源:https://www.cnblogs.com/RegicideGod/p/12598278.html think-swagg ...
一款vue编写的功能强大的swagger-ui，有点秀（附开源地址）
点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试文章作者:RegicideGod cnblogs.com/Regici ...
sosoApi 环境搭建
[SosoApi] http://www.sosoapi.com/ [linux环境下搭建SosoApi工程] 前提:安装并启动mysql 创建database 比如sosoapi,执行工程中自带的 ...
idea swagger生成接口文档_spring boot集成Swagger-UI接口文档
本文介绍如何用spring boot集成Swagger-UI,实现项目在线接口文档一.Swagger-UI简介 Swagger是一个Restful风格接口的文档在线自动生成和测试的框架官网对Swa ...
采用 Vue 编写的功能强大的 Swagger-ui 页面
点击上方好好学java ,选择星标公众号重磅资讯.干货,第一时间送达今日推荐:2020年7月程序员工资统计,平均14357元,又跌了,扎心个人原创100W+访问量博客:点击前往,查看更多 sw ...
delphi ui编辑工具源码_一种无侵入比swagger-ui兼容性更好更简单的API文档生成方案
在后端项目中,难免遇到需要写接口文档方便第三方调用的场景,一般业界最常用的方案是使用swagger.Java项目中,一般采用springfox项目,它集成了swagger和swagger-ui,不需要 ...
swagger报错No handler found for GET /swagger-ui.html
今天下载jeeweb框架下来研究,其他还有,就是swagger老是出不来.报错:No handler found for GET /swagger-ui.html 后来搜索才发现,这个错误,是因为资源 ...
SpringFox 3.0.0（包含springfox-swagger2-3.0.0）——无法访问/swagger-ui.html解决方案
问题描述 Maven <dependency><groupId>io.springfox</groupId><artifactId>springfox- ...
【若依(ruoyi)】swagger 自定义 swagger-ui.html 的路径
前言 springfox-swagger 2.9.2 spring boot 2.2.13.RELEASE http://springfox.github.io/springfox/ 自定义 swag ...

SwaggerUI--SosoApi

SwaggerUI--SosoApi相关推荐

最新文章

热门文章