侧边栏壁纸
  • 累计撰写 39 篇文章
  • 累计创建 1 个标签
  • 累计收到 3 条评论
标签搜索

【深入浅出-项目】(1):接口文档自动生成

mousycoder
2018-10-22 / 0 评论 / 0 点赞 / 103 阅读 / 940 字
温馨提示:
本文最后更新于 2022-01-20,若内容或图片失效,请留言反馈。部分素材来自网络,若不小心影响到您的利益,请联系我们删除。

简介

server-api是一个GUI的Web接口管理工具,基于 swagger-ui 的后台API开源项目,采用SpringMvc+Maven3+Jdk1.7+Tomcat7,该项目的初衷是为了更好的去发展Swagger-ui与SpringMvc的结合,希望能够更加灵活,轻量化的根据后台不同的数据源展示出不同接口文档,满足日益增长的接口文档需求,这里包括(接口文档的格式,权限,视图,Mock数据,Api监控,自动化测试,接口文档分享,版本管理等),server-api可以帮助后台开发人员解放双手,直接用注解生成文档,省去与前端、测试的沟通,以及项目上线后问题的监控和排查。

亮点

  • 完美融合Spring3.2.9+,采用注解编写文档,适用于目前大多数项目。
  • 最简项目架构,方便快速上手,排除其他干扰,方便学习研究。
  • 免费的技术支持,提问请在GitHub上Issue

项目地址

https://github.com/mousycoder/server-api

部署

准备工作

  • Eclipse/MyEclipse/IDEA
  • JDK1.7+
  • Tomcat7.*+
  • Git
  • Maven3插件

构建项目

获取源代码

如果你只是使用

git clone git@github.com:mousycoder/server-api.git
git checkout master

如果你也想和我一起开发

  • 先Fork
  • PR一下我的最新代码(develop分支)
  • 贡献代码
  • PR你的代码到我的仓库

若是好的建议和方案,你将会在作者的仓库看到你贡献的代码,这将是多么让人兴奋的事情。

导入IDE

以Eclipse为例,在File->Import->Existing Maven Projects,将server-api项目导入进来。

启动项目

  • maven clean install
  • 右键Run As-> Run on server (前提配置好tomcat)

日志

  • 改变日志级别 src/main/resources->log4j.properties->log4j.rootLogger=DEBUG, Console改成ERROR级别 默认是debug调试级别。

技术支持

0

评论区