本篇文章给大家谈谈怎么快速写api接口文档,以及api接口文档生成对应的知识点,希望对各位有所帮助,不要忘了收藏本站喔。
今天给各位分享怎么快速写api接口文档的知识,其中也会对api接口文档生成进行解释,如果能碰巧解决你现在面临的问题,别忘了关注本站,现在开始吧!
本文目录一览:
java api接口文档怎么编写?
Java语言提供了一种强大的注释形式:文档注释。可以将源代码里的文档注释提取成一份系统的API文档。我们在开发中定义类、方法时可以先添加文档注释,然后使用javadoc工具来生成自己的API文档。
文档注释以斜线后紧跟两个星号(/**)开始,以星号后紧跟一个斜线(*/)作为结尾,中间部分全部都是文档注释,会被提取到API文档中。
自行搜索一下javadoc即可,示例如下:
1234567891011121314151617181920212223242526272829/** * 类描述 * * @author 作者 * @version 版本 */public class DemoClass { /** * 内部属性:name */ private String name; /** * Setter方法 * @return name */ public String getName() { return name; } /** * Getter方法 * @param name */ public void setName(String name) { this.name = name; } }
使用 API Blueprint 来编写 API 接口文档
API Blueprint 用来编写API文档的一种标记语言,类似于Markdown,具体的语法规则可以在 API Blueprint documentation 查看,文档里面还有一个简短的 API Blueprint tutorial 建议先仔细阅读一下这个教程。
使用 API Blueprint 文档,配合一些开源的工具可以把接口文档渲染成 html 再搭配一个静态服务器,就可以很方便的共享给同事。
相对于 word 这种富文本格式的文档来说, API Blueprint 是纯文本,这样可以很方便的使用版本控制工具 Git 来控制版本。
另外,配合一些工具,可以直接生成一个 mock data 数据,这样只要和后端的同学约定好接口格式,那么前端再开发的时候可以使用 mock data 数据来做测试,等到后端写好接口之后再做联调就可以了。
API Blueprint 社区提供了一些文本编辑器的插件,可以识别 API Blueprint 语法支持语法高亮。
使用 apiblueprint 编写好文档使用,可以使用开源社区提供的一个工具 aglio 来把接口文档渲染成 html 文件, aglio 还会启动一个静态服务器,这样就可以在浏览器里面查看渲染好的文档了。
aglio 的使用教程,可以直接查看官方开发仓库的 readme 文档。另外,这里也有一份资料 使用API-Blueprint 编写 API 文档 可以参考。
如何快速编写api文档
这里所用到的工具就是javadoc2chm.百度”javadoc2chm“下载。我看到有一个1积分下载的,我这里也有,需要的话可以私聊。
2
javadoc2chm.exe的大小只有102k左右,谨防上当受骗啊。
3
使用javadoc2chm制作帮助文档的时候,首先下载的文件中有帮助文档的html版。例如我下载的Struts2就有doc目录。
4
打开javadoc2chm.exe. path to javadoc是用来选择doc的路径的,output filename是用来给输出的chm一个名字,以.chm结尾,title是打开chm后首页的文字
5
我这里以制作Hadoop2.7.1的帮助文档实例。选好目录后,点击Go就开始只做了,制作完成后,go按键变黑色可用,只做好的chm文档存放在你选择的html帮助文档的目录里。
END
注意事项
注意output filename是用来给输出的chm一个名字,以.chm结尾如果不是,输出后改一下
工作愉快!点赞啊。
magic-api 快速接口开发
magic-api 是一个基于Java的接口快速开发框架,编写接口将通过magic-api提供的UI界面完成,自动映射为HTTP接口。
1,引入magic-api-spring-boot-starter依赖
org.ssssssss
magic-api-spring-boot-starter
1.7.1
2,application.yml 中配置
magic-api:
#配置web页面入口
web: /magic/web
resource:
# location: /data/magic-api
type: database # 配置接口存储方式,这里选择存在数据库中
table-name: magic_api_file # 数据库中的表名
3,启动服务,访问magic-api web页面
magic-test/magic/web
1,RequestParam
GET http://localhost:9999/xxx/xxx?name=abcage=49
这样的URL参数magic-api 会自动将name和age映射为同名变量
2,表单参数
POST http://localhost:9999/xxx/xxx
name=abcage=49
这样的表单参数magic-api 也会自动将name和age映射为同名变量。
3,Request Header参数获取
magic-api 会对所有RequestHeader统一封装为一个名为header的变量 如要获取 token 可以通过header.token 来获取。
4,POST请求的Request Body参数获取
{
"name": "magic-api"
}
如要获取name属性 则可通过 body.name 来获取
5,Path参数获取
主要是针对URL定义为http://localhost:9999/user/{id} 的类似接口
如要获取path路径上的id可通过path.id 或 id来获取
6,Cookie,Session参数获取
可以通过cookie.xxx,session.xxx来获取
1,#{} 注入参数,${} 拼接参数
作用和mybatis用法一致
id = #{id};
id=${id};
2,动态SQL参数
通过?{condition,expression}来实现动态拼接SQL,如果条件成立则拼接后部分内容SQL中,与mybatis中的if标签基本一致
return db.select("select * from sys_user ?{id,where id = #{id}}");
相当于mybatis中的
3,Mybatis 语法支持
1.6.0以后的版本支持Mybatis语法
操作入口 db.table('table_name')
1,insert
return db.table('sys_user').insert({ user_name : '李富贵', role : 'admin'})
// insert into sys_user(user_name,role) values('李富贵','admin')
2,update
return db.table('base_dict').primary('code').update({ code: 'insertTerst', name : '测试insert'})
//update base_dict set name = ? where code = ?
3,save
用法和insert相似
return db.table('sys_user').primary('id', uuid()).save({user_name: '李富贵'});
// insert into sys_user(id,user_name) values('xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx','李富贵');
4,select,page,where
return db.table('sys_user').select()
return db.table('sys_user').page()
return db.table('sys_user')
.where()
.like('user_name','%李富贵%')
.eq('role','admin')
.select()
yml中配置分页参数
magic-api:
page-config:
size: size # 页大小的请求参数名称
page: page # 页码的请求参数名称
default-page: 1 # 未传页码时的默认首页
default-size: 10 # 未传页大小时的默认页大小
自动分页
使用yml中配置的分页参数
return db.page("""select * from base_dict_detail""")
手动分页
跳过前3条记录,然后取5条
return db.page("""select * from base_dict_detail""",5,3)
自定义分页参数获取
实现 PageProvider接口,复写getPage方法 {
public Page getPage(RuntimeContext runtimeContext) {
long page = 2;
long pageSize = 3;
return new Page(pageSize, (page - 1) * pageSize);
}
此模式会覆盖yml的配置内容
目前内置了三种状态码,分别为 执行成功(1),参数验证失败(0),以及系统异常(-1)
自定义状态码
magic-api:
response-code-config:
success: 200 #执行成功的code值
invalid: 400 #参数验证未通过的code值
exception: 500 #执行出现异常的code值
默认返回格式
{
"code": 1, // 状态码
"message": "success", // 状态说明
"data": ..., // 返回的数据内容
"timestamp": 1629610503506, // 服务器时间
"executeTime": 1 // 执行时间
}
自定义返回格式
magic-api:
response: |- #配置JSON格式,格式为magic-script中的表达式
{
code: code,
message: message,
data,
timestamp,
requestTime,
executeTime,
}
自定义结构配置
实现ResultProvider接口,重写buildResult方法
引入swagger依赖
在yml文件中配置
magic-api:
swagger-config:
version: 1.0.0
description: magic测试文档
title: magic测试
name: 配置化实现
location: /v2/api-docs/magic-api/swagger2.json
Magic-api通过springboot自动配置的方式配置了resource,dataSource,interceptor等内容。
在服务启动时,生成MagicConfiguration注入容器时,通过mappingHandlerMapping.registerAllMapping();来注册所有映射(即在界面上配置的接口请求地址和接口的实际处理类、方法的映射)。映射关系注册到handleMapping中,并在内存中通过ConcurrentHashMap来缓存映射关系
接口调用时,在DispatcherServlet中通过url去寻找handler,找到magic-api的统一处理RequestHandler以及处理方法invoke。
在invoke中根据请求方法和路径获取接口信息封装在ApiInfo中,然后进行参数的验证封装。实际脚本的执行,以及对返回结果的包装
关于怎么快速写api接口文档和api接口文档生成的介绍到此就结束了,不知道你从中找到你需要的信息了吗 ?如果你还想了解更多这方面的信息,记得收藏关注本站。
怎么快速写api接口文档的介绍就聊到这里吧,感谢你花时间阅读本站内容,更多关于api接口文档生成、怎么快速写api接口文档的信息别忘了在本站进行查找喔。
版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。
暂时没有评论,来抢沙发吧~