swagger-ui-theme - 蚀刻 swagger-ui 主题


MIT
跨平台
JavaScript

软件简介

swagger-ui-theme 自己编写的SwaggerUI的一个主题, 是一个纯前端项目

应用技术:

react + UMI + DVA + Ant Design

原理

对swagger的json字符串进行解析, 然后将解析到的字符串做一定转换,展示到这套UI主题上

特点:

  • swagger ui theme与原来的swagger ui, 整体结构改为了左右结构

  • 请求参数划分的更清晰(界面中明确区分:普通表单, request body, request header)

  • 解决了原swagger-ui,post文件下载时,如果下载文件名是中文,是一串转义字符串的问题(不过要后端要按照要求进行相关设置)

  • 支持api搜索

  • 支持中/英文切换

  • 文档地址输入框能自动提示文,避免记不住swagger文档的json字符串地址的尴尬

不足:

  • 暂不支持文件上传接口的测试

部署方式和二次开发方式

详见项目的README.md文档,此处不再赘述

源码地址

github: https://github.com/free-pan/swagger-ui-theme.git

gitee: https://gitee.com/free_pan/swagger-ui-theme.git

部分截图