SosoApi,编辑Swagger UI的神器

对于IT码农来说API文档是再熟悉不过的东东。特别是API文档的编辑和交流更是相当的虐心。

就个人来说，使用过编辑API文档的工具，从最原始的口口相授，到接下的苦逼word和上个项目在用的dokuwiki，没有一个让自己很满意的。要么是编辑太麻烦，升级时还要传来传去，如word,要么及时可以在线编辑吧，又得去熟悉相关的编辑语法，如wiki。更要命的是有时一个接口明明自测是可以的，然后有一天前端人员跑过来跟你说，接口调用失败，这个时候别提有多郁闷了。因为你要根据接口文档在rest工具上重新跑一遍，测下接口是否真的用不了，参数少点还好说，有时好几个参数就更繁琐了。每当这个时候，就总在想，如果有一个工具既可以当api接口文档来看，也可以直接测试，马上看到结果，那无论对于前端还是后端都是爽歪歪的。

偶尔一个机会在一个技术交流群里看到有人提到有个api工具挺好用的，swagger ui。当即上网搜索了下，用的人还蛮多的，于是到其官网小逛一下。这一逛可把我乐开了花，这不是我正一直苦苦找寻的吗？界面简单明了，功能强大，可直接在线表单式测试接口(具体效果可以看文章末尾)。于是，我就兴冲冲的下载，看说明文档，写demo。前前后后总共折腾了2天，后来发现使用上还是有些许的不方便。主要有2点，其一，集成使用上，要么通过服务端代码嵌入，这样就跟业务代码偶尔在一起了，而且无法单独部署；要么手动编写对应的json格式文档，文档结构又比较复杂，而且无法多个人协助。其二，如果是手动编辑json文档的话又不支持自定义格式，只能一次一层还不能嵌套，蛋疼不已。

我个人是觉得，文档就是文档，最好不要跟业务代码耦合在一起，于是一开始就摈弃了服务端集成方式，就想着看下有没什么简便的方法来编写json格式文档。本来有打算写个小工具以表单的形式来编辑，这样就爽多了。可惜只是想想而已，后来其他事忙着，也就没去再想这个事。

很凑巧，又在一个群里看到有位哥们在推广他的网站SosoApi(www.sosoapi.com)，说是专注于API接口管理和线上线下测试的，而且刚好又是用的SwaggerUI。于是，很好奇的点击进去一探究竟，看下是怎样一个网站，名字还这么奇怪，soso。。。不用不知道，一用吓一跳，这不就是专门为我写的吗？编辑起Swagger UI的json文档那是相当轻松啊，而且不但可以在线预览还可以下载到本地部署。估计网站的攻城狮也觉得API文档还是本地比较保险比较安全吧。这个必须赞一个。

虽然好久不写技术blog了，不过，这个网站确实不错，有在用SwaggerUI的同行或打算从原来API接口文档的苦逼中跳出来的确实可以试着用下。

SosoApi,编辑Swagger UI的神器相关推荐

使用 Swagger UI 与 Swashbuckle 创建 RESTful Web API 帮助文件
作者:Sreekanth Mothukuru 2016年2月18日本文旨在介绍如何使用常用的 Swagger 和 Swashbuckle 框架创建描述 Restful API 的交互界面,并为 AP ...
C# ABP WebApi与Swagger UI的集成
C# ABP WebApi与Swagger UI的集成本文是配置WebApi与Swagger UI,可以参照 http://www.cnblogs.com/farb/p/ABPSwaggerUIIn ...
ASP.NET Core 在 Swagger UI 中显示自定义的 Header Token
Swagger 是个好东西,对于前后端分离的网站来说,不仅是提高前后端开发人员沟通效率的利器,也大大方便了后端人员测试 API.有时候,API 中可能需要在 Header 中设置认证参数,比如 aut ...
Flask 系列之构建 Swagger UI 风格的 WebAPI
说明操作系统:Windows 10 Python 版本:3.7x 虚拟环境管理器:virtualenv 代码编辑器:VS Code 实验环境初始化 # 创建项目目录 mkdir helloworl ...
Swagger UI
Swagger UI allows anyone - be it your development team or your end consumers - to visualize and inte ...
Swagger UI 与SpringMVC的整合 II
pom.xml <dependency><groupId>io.springfox</groupId><art ...
SpringMVC+JWT+Swagger UI+RestFul
前言: 其实很早就想写这篇文章了,因为我觉得这会对很多新手有指引作用,当初自己也是瞎子过河的摸索着过来的.目前后台开发比较流行的MVC框架中使用Spring MVC还是比较多的,当然还有Spring ...
[第二篇]如何在ASP.Net Core的生产环境中使用OAuth保护swagger ui
在我上篇文章如何在ASP.Net Core的生产环境中保护swagger ui中,我们讨论了如何使用基本身份验证来保护 swagger ui. 使用 OAuth 2.0 和 OpenIdConnect ...
openapi_MicroProfile OpenAPI上的Swagger UI
openapi MicroProfile OpenApi为我们提供了一种使用OpenApi 3描述我们JAX-RS API的标准化方法.如果您以前使用过swagger-jaxrs和swagger- 批 ...
MicroProfile OpenAPI上的Swagger UI
MicroProfile OpenApi为我们提供了一种使用OpenApi 3描述我们JAX-RS API的标准化方法.如果您以前使用过swagger-jaxrs和swagger-annotation ...

SosoApi,编辑Swagger UI的神器

SosoApi,编辑Swagger UI的神器相关推荐

最新文章

热门文章