jstree中文api文档_还在用 Swagger(丝袜哥)生成接口文档?我推荐你试试它。。。...
快速开始
要使得JApiDcos正确工作,你写的代码应该是像下面的样子的:
/**
* 用户接口
*/@RequestMapping("/api/user/")@RestControllerpublic class UserController {/**
* 用户列表
* @param listForm
*/@RequestMapping(path = "list", method = {RequestMethod.GET, RequestMethod.POST} )public ApiResult> list(UserListForm listForm){return null;
}/**
* 保存用户
* @param userForm
*/@PostMapping(path = "save")public ApiResult saveUser(@RequestBody UserForm userForm){return null;
}
}
我们给Controller类和方法加上必要的注释,给接口方法返回相关的对象类型。是的,这样JApiDocs就能解析到相关的接口信息了,就跟我们平时写的代码是差不多的,但要注意,你要通过@param
来告诉JApiDocs接口的参数,但在IDE的帮助下,这个工作将是轻松愉悦的:
然后你在任意一个main
入口方法执行下面的代码就可以生成文档了:
DocsConfig config = new DocsConfig();
config.setProjectPath("your springboot project path"); // 项目根目录
config.setProjectName("ProjectName"); // 项目名称
config.setApiVersion("V1.0"); // 声明该API的版本
config.setDocsPath("your api docs path"); // 生成API 文档所在目录
config.setAutoGenerate(Boolean.TRUE); // 配置自动生成
Docs.buildHtmlDocs(config); // 执行生成文档
接下来你只管好好写代码,生成Api文档的工作就可以交给JApiDocs了,你不需要再为额外编写和维护文档而烦恼。
功能特性
1、代码即文档JApiDocs是通过直接解析SpringBoot的源码语法来工作的,所以只要Controller的语法符合一定的代码规范,有合理的注释,就可以直接导出文档。2、支持导出HTML便捷的导航和接口查看界面;可本地预览,或者部署到HTTP服务器。推荐部署到服务器,方便前后端展开协作。3、同步导出客户端Model代码支持导出Android端的 Java 和iOS端的 Object C Model代码,减少前端程序员的重复编码工作。4、更多特性支持接口搜索;支持不同版本和英文文档;自定义扩展等。
简洁的文档
再好用的东西,如果没有文档说明,别人也无从入手。为了让大家尽快上手,JApiDocs准备了一份极简的文档说明,确保你在几分钟就能用上JApiDocs。花5分钟不到就能认识一个提高工作效率的工具,让你把更多的时间花在更加有价值的事情上,你确认不看一下吗?“仓库地址:https://github.com/YeDaxia/JApiDocs“中文文档:https://japidocs.agilestudio.cn/#/zh-cn/
jstree中文api文档_还在用 Swagger(丝袜哥)生成接口文档?我推荐你试试它。。。...相关推荐
- Api 接口文档是什么?如何直接使用 ApiDoc 生成接口文档
api接口文档 现代化开发大部分都是一种前后端分离的开发模式,前端与后端分别独立进行开发.等后续再去统一的联调.前后端分离的开发模式下,前后端沟通的成本增加,如何减少口头的交流成了关键.这时有一份高端 ...
- idea swagger生成接口文档_Spring Boot(九)Swagger2自动生成接口文档和Mock模拟数据...
一.简介 在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...
- springboot 中文文档_还在用 Swagger生成接口文档?我推荐你试试它
JApiDocs是一个无需额外注解.开箱即用的SpringBoot接口文档生成工具. 编写和维护API文档这个事情,对于后端程序员来说,是一件恼人但又不得不做的事情,我们都不喜欢写文档,但除非项目前后 ...
- 【转】Postman 生成接口文档
引言 几个朋友想做一个前后端分离的项目,接口文档的重要性那是不言而喻的.生成接口文档的方法真的太多了,Yapi.Swagger等等.但是想公网上访问接口文档并修改的话,还得购买服务器,部署上去.穷码农 ...
- axis2生成客户端代码_利用ApiPost一键、快速生成接口文档!女猿也过38节!
对于我们这些程序员和程序媛来讲,最头疼的莫过于写文档. 我们可都是正个八经的理工校草和理工女神,研究github.逛逛csdn.写hello world是才我们的拿手菜,写文档是文科生的事情好不啦?( ...
- Go 项目自动生成接口文档
CSDN 中文章不一定能及时更新,欢迎关注我的博客查看最新版本:许盛的博客 背景 如何让后端同学愉快地写接口文档,是个老大难问题. 使用 GraphQL 当接口标准,倒是省了接口文档的问题,连前端代码 ...
- 实体类 接口_spring-boot-route(五)整合Swagger生成接口文档
目前,大多数公司都采用了前后端分离的开发模式,为了解决前后端人员的沟通问题,后端人员在开发接口的时候会选择使用swagger2来生成对应的接口文档,swagger2提供了强大的页面调试功能,这样可以有 ...
- Spring Boot(九)Swagger2自动生成接口文档和Mock模拟数据
一.简介 在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...
- SpringBoot 如何生成接口文档,老鸟们都这么玩的!
为什么要用Swagger ? " 作为一名程序员,我们最讨厌两件事:1. 别人不写注释.2. 自己写注释. 而作为一名接口开发者,我们同样讨厌两件事:1. 别人不写接口文档,文档不及时更新. ...
最新文章
- react-native 常用命令
- libgdx 1.4.1公布
- CoordinatorLayout+AppBarLayout实现上滑隐藏ToolBar-Android M新控件
- 转化百分比_小秘诀教你如何快速提升大众点评访客转化率!
- c语言case无参,如何使用可变参数模板构建switch-case
- jQuery DataTables
- 通过stream去重_stream去重
- 这篇纯数据分析文章被拒8次,发到行业顶刊
- CS184.1X 计算机图形学导论 第8讲 学习笔记
- 无任何歧视!任正非:愿意把5G技术授权给一家美国公司
- 程序员,保险公司招聘不要轻易跑过去,省省路费省省时间,别浪费感情,特别是招聘什么业务主管经理的...
- PDF转CAD经典软件有什么
- vb.net word 自定义工具栏_20个Word文字处理快速掌握技巧
- 机器学习之信用卡欺诈检测
- python--控制窗体
- idea mybatis 常用插件
- 运维开发面试题集锦(25k-35k)
- 1.(group by)如何让group by分组后,每组中的所有数据都显示出来
- 通过SQL语句实现搜索附近的人
- python format使用
热门文章
- 微信公众号自定义菜单设置管理
- 职业教育计算机课教学反思,职高课后的教学反思(精选5篇)
- 9个元素换6次达到排序序列_排序总结:二大种,六小种排序方式
- 阿里云cloudmonitor服务导致CPU暴增的异常
- Handler的源码分析
- [Azure][PowerShell][ASM][12]ACL
- 《深入理解Android:卷III A》一一第3章 深入理解AudioService
- HDU(1175),连连看,BFS
- Linux 多用户和多用户边界
- Matlab符号求导