API 接口文档管理器 Mirren-Swagger-API-Manager

MIT
Java 查看源码»
跨平台
2018-11-01
Mirren

Mirren-Swagger-API-Manager

MSAM是一个API接口文档管理器,MSAM的属性根据swagger-models-1.5.20.jar进行定义并添加了拓展属性
MSAM以项目-接口分组-接口三个单位,项目最终生成的结果理论上兼容Swagger的Swagger UI
不过MSAM也有一个属于自己的Client-UI,可以方便的查看检索接口文档

一些疑问

  • 问:为什么有Swagger了还要这个东西?

  • 答:因为大多前后端分离的公司基本都跟本人公司一样,先接口文档然后才有项目;而Swagger是用注解现有的项目生产接口,如果用Swagger Editor写又觉得不方便管理,所以就有了这个东西

  • 问:为什么已经有了Swagger UI了还要搞一个MSAM Client-UI?

  • 答:本人不喜欢Swagger UI的风格,本人的同事看Client-UI的风格已经很久了

  • 问:市面上已经有接口文档管理了(比如阿里的RAP等)为什么你还要自己写

  • 答:本人蛋疼

项目的结构

  • 项目的后台采用了大部分人熟悉的SpringBoot写(其实本人与公司已经用Vert.x一年多了,不是很喜欢Spring),

  • 文件存储使用JDBC操作Sqlite3数据库

  • Server-UI用于管理接口文档(Bootstrap)

  • Client-UI用于展示接口文档(Bootstrap Docs)

项目如何运行

  • 运行环境要求,开发环境为java 1.8.0_121,理论上java1.8以上都可以运行,如果没有java运行环境,可以看使用说明里面的免JDK教程

  • 项目可以在releases(发行版)里面下载已经打包好的也可以自己打包项目

  • 执行 mvn clean package 进行项目打包

  • 执行完毕后 进入target/MSAM目录,该目录包含了Client-UI(展示接口文档的UI),Server-UI(管理接口的UI),config(存放接口文档的Sqlite,旧版升级可以将旧版的数据拷贝到新版中),Mirren-Swagger-API-Manager-x.x.x.jar

  • 在MSAM目录中执行java -jar Mirren-Swagger-API-Manager-x.x.x.jar 启动MSAM服务,端口号默认为8686(可以自己修改,Server-UI端口的修改在js/common.js中)

  • 进入Server-UI在浏览器中打开index.html便可以进行接口管理

  • 进入Client-UI在浏览器中打开index.html在顶部的输入接口文件的Json地址,或者选择本地的Json文件进行加载接口

拓展与二次开发

数据库里面定义了项目,接口分组,以及接口三张表,属性对应Swagger的Swagger,Tags,Operation这三个类,前端操作需要将Json类型转换为String类型

使用说明

  • 第一步启动Mirren-Swagger-API-Manager.jar(start.bat / start.sh)

  • 第二步访问Server-UI-index.html

  • 第三步新建项目,输入项目信息后确定创建项目

  • 第四步在项目列表中点击项目

  • 第五步新建接口

  • 第六步新建接口

  • 第七步在项目信息中选择将项目转为Swagger_2.0 .Json文件并下载或在线查看获得文件路径

  • 第八步访问Client-UI-index.html

  • 第九步打开保存的文件,或者输入文件路径加载数据

界面展示

Server-UI

Server-UI

Client-UI

Client-UI Client-UI

的码云指数为
超过 的项目
加载中

评论(3)

子杨
子杨
为什么不用postman的文档...自己调试接口过程就把文档生成了HTML文档......而且是可以直接给前端使用的文档..
gggggame
gggggame
本地化
北京老爷们儿
北京老爷们儿
好个蛋疼!

暂无资讯

暂无问答

将 Java 项目推送到 Maven 中央仓库实践

欢迎关注我的博客:http://www.mydlq.club 最新写了个开源项目 Swagger Kubernetes,考虑到发布到 Maven 中央仓库,发布成功,全球通用,在 Maven 拉取的过程中不存在 Jar 包不在无法下载的问...

06/01 14:47
7
0
Swagger上手教程

swagger零基础教程

2016/07/23 21:08
1K
0
Swagger Integration

This wiki writes down the integration between spring-boot and Swagger. Swagger is a powerful restful API framework. It can discover and generate documentation for rest API by us...

2016/04/26 15:35
30
1
swagger入门及swagger-maven-plugin使用

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful风格的Web服务。[推荐-翻译](

2016/04/16 15:29
2.6K
1
用Swagger调用Harbor Registry的REST API

本文原作者为开源企业级容器Registry Harbor项目的工程师王锟,主要介绍如何使用Harbor内置Swagger来测试和调用Harbor的API。笔者做了少量修改。 Swagger简介 Swagger是最流行的RESTful API...

2016/04/21 11:26
1K
1
Swagger使用和注释介绍

介绍 什么是Swagger Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数...

07/12 18:44
25
0
swagger

随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了:前端渲染、先后端分离的形态,而且前端技术和后端技术在各自的道路上越走越远。 前端和后端的唯一联系,变成了API接口...

2018/12/06 19:04
19
0
Swagger webservice doc generation

Swagger Javadoc Link: https://github.com/ryankennedy/swagger-jaxrs-doclet Usage: Allow swagger definition json file to begenerated on building the maven project. Add the followi...

2014/07/01 12:02
62
0
推荐一款接口 API 设计神器!

今天栈长给大家推荐一款接口 API 设计神器,传说中的,牛逼哄洪的 Swagger,它到底是什么?今天为大家揭开谜底! Swagger是什么? 官网:https://swagger.io/ Swagger 如官网所示,它是最好的...

02/20 08:52
39
0
使用springfox 集成swagger 与spring mvc

使用springfox 集成swagger 与spring mvc

2016/07/29 11:32
1K
0

没有更多内容

加载失败,请刷新页面

返回顶部
顶部