excel能翻译中文吗
873
2023-01-02
API在线文档及案例（api文档编写）
本篇文章给大家谈谈API在线文档及案例，以及api文档编写对应的知识点，希望对各位有所帮助，不要忘了收藏本站喔。
今天给各位分享API在线文档及案例的知识，其中也会对api文档编写进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！
Api接口可以应用于pc端、app、软件等，除了接口一般会有Api接口文档说明来帮助开发者使用。
下面来分享一下免费的api接口以及文档说明：
1. 邮编查询：
接口地址：http://v.juhe.cn/postcode/query
返回格式：json/xml
请求方式：http get/post
请求示例：http://v.juhe.cn/postcode/query?postcode=215001key=申请的KEY
接口备注：通过邮编查询对应的地名
请求参数说明：
名称 类型 必填 说明
postcode 是 string 邮编，如：215001
key 是 string 应用APPKEY(应用详细页查询)
page 否 int 页数，默认1
pagesize 否 int 每页返回，默认:20,最大不超过50
dtype 否 string 返回数据的格式,xml或json，默认json
返回参数说明：
名称 类型 说明
error_code int 返回码
reason string 返回说明
JSON返回示例：
{
"reason": "successed",
"result": {
"list": [
{
"PostNumber": "215001",
"Province": "江苏省",
"City": "苏州市",
"District": "平江区",
"Address": "廖家巷新光里"
},
{
"PostNumber": "215001",
"Province": "江苏省",
"City": "苏州市",
"District": "平江区",
"Address": "龙兴桥顺德里"
}
],
"totalcount": 352,
"totalpage": 176,
"currentpage": 1,
"pagesize": "2"
},
"error_code": 0
}
2. 手机号码归属地:
接口地址：http://apis.juhe.cn/mobile/get
返回格式：json/xml
请求方式：get
请求示例：http://apis.juhe.cn/mobile/get?phone=13429667914key=您申请的KEY
请求参数说明：
名称 类型 必填 说明
phone 是 int 需要查询的手机号码或手机号码前7位
key 是 string 应用APPKEY(应用详细页查询)
dtype 否 string 返回数据的格式,xml或json，默认json
返回参数说明：
名称 类型 说明
error_code int 返回码
reason string 返回说明
result string 返回结果集
province string 省份
city string 城市，(北京、上海、重庆、天津直辖市可能为空)
areacode string 区号，(部分记录可能为空)
zip string 邮编，(部分记录可能为空)
company string 运营商
JSON返回示例：
{
"resultcode":"200",
"reason":"Return Successd!",
"result":{
"province":"浙江",
"city":"杭州",
"areacode":"0571",
"zip":"310000",
"company":"中国移动",
"card":""
}
}
XML返回示例：
<?xml version="1.0" encoding="utf-8" ?
- <root
<resultcode200</resultcode
<reasonReturn Successd!</reason
- <result
<province浙江</province
<city杭州</city
<areacode0571</areacode
<zip310000</zip
<company中国移动</company
<card</card
</result
</root
3. 影视影讯检索：
接口地址：http://op.juhe.cn/onebox/movie/video
返回格式：json/xml
请求方式：http get/post
请求事例http://op.juhe.cn/onebox/movie/video?key=APPKEYq=%E5%BA%B7%E7%86%99%E7%8E%8B%E6%9C%9D
接口备注：电影：q=心花路放；电视剧：q=继承者们；动漫：q=柯南
请求参数说明：
名称 类型 必填 说明
key 是 string 应用APPKEY(应用详细页查询)
dtype 否 string 返回数据的格式,xml或json，默认json
q 是 string 影视搜索名称
返回参数说明：
名称 类型 说明
error_code int 返回码
reason string 返回说明
JSON返回示例：
{
"reason": "查询成功",
"result": {
"title": "闪电侠第一季",
"tag": "科幻 / 动作",
"act": "格兰特·古斯汀 埃涅·赫德森 汤姆·卡瓦纳夫",
"year": "2014",
"rating": null,
"area": "美国",
"dir": "大卫·努特尔",
"desc": "《闪电侠》精彩看点：二次元超级英雄再登电视荧屏，《闪电侠》无缝对接《绿箭侠》闪耀登场。《闪电侠》剧情梗概：《闪电侠》的漫画连载开始于1940年，讲述了一名拥有超级速度的学生的故事。50年代起，这个角色则被重新诠释，成为了巴里·艾伦，一名为警署工作的科学家，使用他的超级速度来对抗超级反派们。",
"cover": "http://i.gtimg.cn/qqlive/img/jpgcache/files/qqvideo/0/0l01jm9yobh4xo4.jpg",
"vdo_status": "play",
"playlinks": {
"youku": "http://v.youku.com/v_show/id_XODQ1NTAzNDE2.html?tpa=dW5pb25faWQ9MTAyMjEzXzEwMDAwNl8wMV8wMQ",
"qq": "http://v.qq.com/cover/0/0l01jm9yobh4xo4/g0015dn2fw1.html",
"leshi": "http://www.letv.com/ptv/vplay/21416940.html",
"pptv": "http://v.pptv.com/show/2uhW1T2jE1G0Mr4.html",
"sohu": "http://tv.sohu.com/20141210/n406824703.shtml?txid=4e4df35dda9d8ed32c874b1ad590ef59"
},
"video_rec": [
{
"detail_url": "http://kan.com/tv/PrVtaX7kRzXsMn.html",
"cover": "http://p2.qhimg.com/t01f969930fae67d1ec.jpg",
"title": "神盾局特工 第2季"
},
{
"detail_url": "http://kan.com/tv/Q4RvaqOoRmDuMX.html",
"cover": "http://p6.qhimg.com/t0160a8a6f5b768034a.jpg",
"title": "遗失的世界"
},
{
"detail_url": "http://kan.com/tv/Q4Frc3GoRmbuMX.html",
"cover": "http://p7.qhimg.com/t01513514907831e055.jpg",
"title": "浩劫余生 第一季"
},
{
"detail_url": "http://kan.com/tv/QrFob33oRGboMX.html",
"cover": "http://p6.qhimg.com/d/_hao360/video/img200909_18_145544738.jpg",
"title": "新绿野仙踪之铁皮人"
},
{
"detail_url": "http://kan.com/tv/QrRtbaOpRz4nOH.html",
"cover": "http://p1.qhimg.com/t01d2996b3305923b91.jpg",
"title": "陨落星辰第三季"
}
],
"act_s": [
{
"name": "格兰特·古斯汀",
"url": "http://baike.so.com/doc/2041872.html",
"image": "http://p3.qhimg.com/dmsmty/120_110_100/t019f2fb2f92c6cb2cf.jpg"
},
{
"name": "埃涅·赫德森",
"url": "http://baike.so.com/doc/3938849.html",
"image": "http://p2.qhimg.com/dmsmty/120_110_100/t0169332727e692e9fa.jpg"
},
{
"name": "汤姆·卡瓦纳夫",
"url": "http://baike.so.com/doc/7521211.html",
"image": "http://p0.qhimg.com/dmsmty/120_110_100/t01d271d8c090330ae2.jpg"
}
]
},
"error_code": 0
}
4. 商品比价查询：
API调用地址：
http://sapi.manmanbuy.com/Search.aspx?AppKey=申请appkeyKey=搜索关键词Class=分类IDBrand=品牌IDSite=商城IDPriceMin=最低价PriceMax=最高价PageNum=页号PageSize=每页商品数OrderBy=排序方式ZiYing=是否自营ExtraParameter=扩展参数
调用示例
http://sapi.manmanbuy.com/Search.aspx?AppKey=123456Key=iphoneClass=0Brand=0Site=0PriceMin=0PriceMax=0PageNum=1PageSize=30OrderBy=scoreZiYing=falseExtraParameter=0
返回结果示例(以iphone为例，显示前2条商品信息)：
{"State":1000,"SearchItemsCount":101520,"SearchCount":5109,"ClassList":"57|1074|手机,893|29964|iPhone 配件,892|19512|手机保护套,910|11169|苹果配件, 890|8766|手机贴膜 ,894|6201|其它配件,900|3189|移动电源,889|2067|手机充电器,898|1923|电池/充电器,101|1518|耳机,888|1290|手机电池, 100|1074|蓝牙耳机","BrandList":"155|47184|苹果,0|40476|,634|2166|洛克,6|1134|三星,622|1023|倍思,261|564|品胜,652|558|SGP, 639|537|ESR,623|474|邦克仕,10|423|飞利浦,604|330|摩米士,664|291|优胜仕","SiteList":"1|66732|京东商城,4|8478|亚马逊,3|7917| 当当,13|4821|1号店,6|4605|苏宁易购,8|4149|国美在线,11|3882|易迅网,9|360|新蛋网,161|168|飞牛网,185|147|顺电网,124|123|高鸿商城, 123|69|华强北","SearchResultList":[{"spname":"苹果(Apple)iPhone 6 (A1586) 16GB 金色 移动联通电信4G手机", "sppic":"http://img14.360buyimg.com/n7/jfs/t277/193/1005339798/768456/29136988/542d0798N19d42ce3.jpg", "spurl":"http://item.jd.com/1217499.html","spprice":"5188.00","className":"手机","brandName":"苹果","siteName":"京东商城", "commentUrl":"http://item.jd.com/1217499.html#comments-list","commentCount":"8773", "TitleHighLighter":"苹果(Apple)iPhone 6 (A1586) 16GB 金色 移动联通电信4G手机","ziying":"1","siteid":"1","id":"98084930"}, {"spname":"苹果(Apple)iPhone 6 Plus (A1524) 16GB 金色 移动联通电信4G手机", "sppic":"http://img14.360buyimg.com/n7/jfs/t346/302/1010969394/231745/50f20b36/542d0e26N894372e9.jpg", "spurl":"http://item.jd.com/1217524.html","spprice":"5988.00","className":"手机","brandName":"苹果","siteName":"京东商城", "commentUrl":"http://item.jd.com/1217524.html#comments-list","commentCount":"10288", "TitleHighLighter":"苹果(Apple)iPhone 6 Plus (A1524) 16GB 金色 移动联通电信4G手机","ziying":"1","siteid":"1","id":"98084932"}]}
而手写 api 文档的话有诸多痛点：
Swagger 就很好地解决了这个问题。
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。
访问 swagger-ui.html 进行接口在线测试
用于类，表示表示这个类是swagger的资源。属性如下：
用于方法，表示一个http请求的操作。属性如下：
用于方法、参数、字段说明；表示对参数的添加元数据。
用于类，表示对类进行说明，用于参数用实体类接受。
用于方法、字段，表示对model属性的说明或者数据操作更改。
用于类、方法、方法参数，表示这个方法或者类被忽略，不在swagger-ui.html上显示。
用于方法，表示单独的请求参数。
用于方法，包含多个 @ApiImplicitParam。
用于类或者方法，描述操作的可能响应。
用于方法，响应头设置。
添加依赖
转换工具类
使用测试 Controller
添加依赖
可以修改此处 html 和 pdf，通过 mvn asciidoctor:process-asciidoc 可以导出相应格式文件
执行 mvn asciidoctor:process-asciidoc 后再执行 mvn generate-resources，可在 targt/generated-docs 目录下生成 xml 格式文件 关于API在线文档及案例和api文档编写的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。 API在线文档及案例的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于api文档编写、API在线文档及案例的信息别忘了在本站进行查找喔。
本文目录一览：
免费API接口的试用开发文档有吗
Api接口就好比一个媒介工具，比如买东西的时候我们要计算价格，可以用算盘、计算器、手机或者电脑进行计算得出结果。接口与其类似，当你需要用到这个功能时就可以调用。Api接口可以应用于pc端、app、软件等，除了接口一般会有Api接口文档说明来帮助开发者使用。
下面来分享一下免费的api接口以及文档说明：
1. 邮编查询：
接口地址：http://v.juhe.cn/postcode/query
返回格式：json/xml
请求方式：http get/post
请求示例：http://v.juhe.cn/postcode/query?postcode=215001key=申请的KEY
接口备注：通过邮编查询对应的地名
请求参数说明：
名称 类型 必填 说明
postcode 是 string 邮编，如：215001
key 是 string 应用APPKEY(应用详细页查询)
page 否 int 页数，默认1
pagesize 否 int 每页返回，默认:20,最大不超过50
dtype 否 string 返回数据的格式,xml或json，默认json
返回参数说明：
名称 类型 说明
error_code int 返回码
reason string 返回说明
JSON返回示例：
{
"reason": "successed",
"result": {
"list": [
{
"PostNumber": "215001",
"Province": "江苏省",
"City": "苏州市",
"District": "平江区",
"Address": "廖家巷新光里"
},
{
"PostNumber": "215001",
"Province": "江苏省",
"City": "苏州市",
"District": "平江区",
"Address": "龙兴桥顺德里"
}
],
"totalcount": 352,
"totalpage": 176,
"currentpage": 1,
"pagesize": "2"
},
"error_code": 0
}
2. 手机号码归属地:
接口地址：http://apis.juhe.cn/mobile/get
返回格式：json/xml
请求方式：get
请求示例：http://apis.juhe.cn/mobile/get?phone=13429667914key=您申请的KEY
请求参数说明：
名称 类型 必填 说明
phone 是 int 需要查询的手机号码或手机号码前7位
key 是 string 应用APPKEY(应用详细页查询)
dtype 否 string 返回数据的格式,xml或json，默认json
返回参数说明：
名称 类型 说明
error_code int 返回码
reason string 返回说明
result string 返回结果集
province string 省份
city string 城市，(北京、上海、重庆、天津直辖市可能为空)
areacode string 区号，(部分记录可能为空)
zip string 邮编，(部分记录可能为空)
company string 运营商
JSON返回示例：
{
"resultcode":"200",
"reason":"Return Successd!",
"result":{
"province":"浙江",
"city":"杭州",
"areacode":"0571",
"zip":"310000",
"company":"中国移动",
"card":""
}
}
XML返回示例：
<?xml version="1.0" encoding="utf-8" ?
- <root
<resultcode200</resultcode
<reasonReturn Successd!</reason
- <result
<province浙江</province
<city杭州</city
<areacode0571</areacode
<zip310000</zip
<company中国移动</company
<card</card
</result
</root
3. 影视影讯检索：
接口地址：http://op.juhe.cn/onebox/movie/video
返回格式：json/xml
请求方式：http get/post
请求事例http://op.juhe.cn/onebox/movie/video?key=APPKEYq=%E5%BA%B7%E7%86%99%E7%8E%8B%E6%9C%9D
接口备注：电影：q=心花路放；电视剧：q=继承者们；动漫：q=柯南
请求参数说明：
名称 类型 必填 说明
key 是 string 应用APPKEY(应用详细页查询)
dtype 否 string 返回数据的格式,xml或json，默认json
q 是 string 影视搜索名称
返回参数说明：
名称 类型 说明
error_code int 返回码
reason string 返回说明
JSON返回示例：
{
"reason": "查询成功",
"result": {
"title": "闪电侠第一季",
"tag": "科幻 / 动作",
"act": "格兰特·古斯汀 埃涅·赫德森 汤姆·卡瓦纳夫",
"year": "2014",
"rating": null,
"area": "美国",
"dir": "大卫·努特尔",
"desc": "《闪电侠》精彩看点：二次元超级英雄再登电视荧屏，《闪电侠》无缝对接《绿箭侠》闪耀登场。《闪电侠》剧情梗概：《闪电侠》的漫画连载开始于1940年，讲述了一名拥有超级速度的学生的故事。50年代起，这个角色则被重新诠释，成为了巴里·艾伦，一名为警署工作的科学家，使用他的超级速度来对抗超级反派们。",
"cover": "http://i.gtimg.cn/qqlive/img/jpgcache/files/qqvideo/0/0l01jm9yobh4xo4.jpg",
"vdo_status": "play",
"playlinks": {
"youku": "http://v.youku.com/v_show/id_XODQ1NTAzNDE2.html?tpa=dW5pb25faWQ9MTAyMjEzXzEwMDAwNl8wMV8wMQ",
"qq": "http://v.qq.com/cover/0/0l01jm9yobh4xo4/g0015dn2fw1.html",
"leshi": "http://www.letv.com/ptv/vplay/21416940.html",
"pptv": "http://v.pptv.com/show/2uhW1T2jE1G0Mr4.html",
"sohu": "http://tv.sohu.com/20141210/n406824703.shtml?txid=4e4df35dda9d8ed32c874b1ad590ef59"
},
"video_rec": [
{
"detail_url": "http://kan.com/tv/PrVtaX7kRzXsMn.html",
"cover": "http://p2.qhimg.com/t01f969930fae67d1ec.jpg",
"title": "神盾局特工 第2季"
},
{
"detail_url": "http://kan.com/tv/Q4RvaqOoRmDuMX.html",
"cover": "http://p6.qhimg.com/t0160a8a6f5b768034a.jpg",
"title": "遗失的世界"
},
{
"detail_url": "http://kan.com/tv/Q4Frc3GoRmbuMX.html",
"cover": "http://p7.qhimg.com/t01513514907831e055.jpg",
"title": "浩劫余生 第一季"
},
{
"detail_url": "http://kan.com/tv/QrFob33oRGboMX.html",
"cover": "http://p6.qhimg.com/d/_hao360/video/img200909_18_145544738.jpg",
"title": "新绿野仙踪之铁皮人"
},
{
"detail_url": "http://kan.com/tv/QrRtbaOpRz4nOH.html",
"cover": "http://p1.qhimg.com/t01d2996b3305923b91.jpg",
"title": "陨落星辰第三季"
}
],
"act_s": [
{
"name": "格兰特·古斯汀",
"url": "http://baike.so.com/doc/2041872.html",
"image": "http://p3.qhimg.com/dmsmty/120_110_100/t019f2fb2f92c6cb2cf.jpg"
},
{
"name": "埃涅·赫德森",
"url": "http://baike.so.com/doc/3938849.html",
"image": "http://p2.qhimg.com/dmsmty/120_110_100/t0169332727e692e9fa.jpg"
},
{
"name": "汤姆·卡瓦纳夫",
"url": "http://baike.so.com/doc/7521211.html",
"image": "http://p0.qhimg.com/dmsmty/120_110_100/t01d271d8c090330ae2.jpg"
}
]
},
"error_code": 0
}
4. 商品比价查询：
API调用地址：
http://sapi.manmanbuy.com/Search.aspx?AppKey=申请appkeyKey=搜索关键词Class=分类IDBrand=品牌IDSite=商城IDPriceMin=最低价PriceMax=最高价PageNum=页号PageSize=每页商品数OrderBy=排序方式ZiYing=是否自营ExtraParameter=扩展参数
调用示例
http://sapi.manmanbuy.com/Search.aspx?AppKey=123456Key=iphoneClass=0Brand=0Site=0PriceMin=0PriceMax=0PageNum=1PageSize=30OrderBy=scoreZiYing=falseExtraParameter=0
返回结果示例(以iphone为例，显示前2条商品信息)：
{"State":1000,"SearchItemsCount":101520,"SearchCount":5109,"ClassList":"57|1074|手机,893|29964|iPhone 配件,892|19512|手机保护套,910|11169|苹果配件, 890|8766|手机贴膜 ,894|6201|其它配件,900|3189|移动电源,889|2067|手机充电器,898|1923|电池/充电器,101|1518|耳机,888|1290|手机电池, 100|1074|蓝牙耳机","BrandList":"155|47184|苹果,0|40476|,634|2166|洛克,6|1134|三星,622|1023|倍思,261|564|品胜,652|558|SGP, 639|537|ESR,623|474|邦克仕,10|423|飞利浦,604|330|摩米士,664|291|优胜仕","SiteList":"1|66732|京东商城,4|8478|亚马逊,3|7917| 当当,13|4821|1号店,6|4605|苏宁易购,8|4149|国美在线,11|3882|易迅网,9|360|新蛋网,161|168|飞牛网,185|147|顺电网,124|123|高鸿商城, 123|69|华强北","SearchResultList":[{"spname":"苹果(Apple)iPhone 6 (A1586) 16GB 金色 移动联通电信4G手机", "sppic":"http://img14.360buyimg.com/n7/jfs/t277/193/1005339798/768456/29136988/542d0798N19d42ce3.jpg", "spurl":"http://item.jd.com/1217499.html","spprice":"5188.00","className":"手机","brandName":"苹果","siteName":"京东商城", "commentUrl":"http://item.jd.com/1217499.html#comments-list","commentCount":"8773", "TitleHighLighter":"苹果(Apple)iPhone 6 (A1586) 16GB 金色 移动联通电信4G手机","ziying":"1","siteid":"1","id":"98084930"}, {"spname":"苹果(Apple)iPhone 6 Plus (A1524) 16GB 金色 移动联通电信4G手机", "sppic":"http://img14.360buyimg.com/n7/jfs/t346/302/1010969394/231745/50f20b36/542d0e26N894372e9.jpg", "spurl":"http://item.jd.com/1217524.html","spprice":"5988.00","className":"手机","brandName":"苹果","siteName":"京东商城", "commentUrl":"http://item.jd.com/1217524.html#comments-list","commentCount":"10288", "TitleHighLighter":"苹果(Apple)iPhone 6 Plus (A1524) 16GB 金色 移动联通电信4G手机","ziying":"1","siteid":"1","id":"98084932"}]}
请教在线文档的api
Android中文版
api手册地址：http://www.matools.com/api/android
Ant最新版
api手册地址：http://www.matools.com/api/ant
ASM字节码操作
api手册地址：http://www.matools.com/api/asm
Axis2最新版
api手册地址：http://www.matools.com/api/axis2
Bash脚本
api手册地址：http://www.matools.com/api/bash
Bootstrap 3
api手册地址：http://www.matools.com/api/bootstrap3
Bootstrap 4
api手册地址：http://www.matools.com/api/bootstrap4
C/C++
api手册地址：http://www.matools.com/api/c
C3P0连接池
api手册地址：http://www.matools.com/api/c3p0
CentOS使用文档
api手册地址：http://www.matools.com/api/centos
Commons-Beanutils
api手册地址：http://www.matools.com/api/commons-beanutils
Commons-Fileupload
api手册地址：http://www.matools.com/api/commons-fileupload
Commons-IO最新版
api手册地址：http://www.matools.com/api/commons-io
Commons-Lang最新版
api手册地址：http://www.matools.com/api/commons-long
Commons-Net最新版
api手册地址：http://www.matools.com/api/commons-net
CSS 3
api手册地址：http://www.matools.com/api/css
DBCP连接池
api手册地址：http://www.matools.com/api/dbcp
Dom4j
api手册地址：http://www.matools.com/api/dom4j
dubbo中文文档
api手册地址：http://www.matools.com/api/dubbo
EhCache
api手册地址：http://www.matools.com/api/ehcache
Freemarker
api手册地址：http://www.matools.com/api/freemarker
Go语言
api手册地址：http://www.matools.com/api/go
Hadoop
api手册地址：http://www.matools.com/api/hadoop
Hibernate中文版
api手册地址：http://www.matools.com/api/hibernate
IKAnalyzer中文版
api手册地址：http://www.matools.com/api/ikanalyzer
Java 10
api手册地址：http://www.matools.com/api/java10
Java 6
api手册地址：http://www.matools.com/api/java6
Java 7
api手册地址：http://www.matools.com/api/java7
Java 8中文版
api手册地址：http://www.matools.com/api/java8
jqGrid中文版
api手册地址：http://www.matools.com/api/jqgrid
Jquery中文版
api手册地址：http://www.matools.com/api/jquery
Json-lib
api手册地址：http://www.matools.com/api/json-lib
Junit4最新版
api手册地址：http://www.matools.com/api/junit
Kryo
api手册地址：http://www.matools.com/api/kryo
Log4j最新版
api手册地址：http://www.matools.com/api/log4j
Lucene
api手册地址：http://www.matools.com/api/lucene
Maven
api手册地址：http://www.matools.com/api/maven
Windows MFC中文版
api手册地址：http://www.matools.com/api/msdn
Mybatis
api手册地址：http://www.matools.com/api/mybatis
MySql中文版
api手册地址：http://www.matools.com/api/mysql
Netty 3.6
api手册地址：http://www.matools.com/api/netty
Nginx中文版
api手册地址：http://www.matools.com/api/nginx
OpenJPA最新版
api手册地址：http://www.matools.com/api/openjpa
PHP中文版
api手册地址：http://www.matools.com/api/php
POI-apache
api手册地址：http://www.matools.com/api/poi
QuickServer
api手册地址：http://www.matools.com/api/quickserver
redis中文参考文档
api手册地址：http://www.matools.com/api/redis
Ruby
api手册地址：http://www.matools.com/api/ruby
Ruby-library
api手册地址：http://www.matools.com/api/ruby-library
Ruby on Rails
api手册地址：http://www.matools.com/api/rubyonrails
Shiro
api手册地址：http://www.matools.com/api/shiro
Spring最新版
api手册地址：http://www.matools.com/api/spring
Spring for Android
api手册地址：http://www.matools.com/api/spring-android
Spring Boot
api手册地址：http://www.matools.com/api/spring-boot
Spring Cloud中文文档
api手册地址：http://www.matools.com/api/spring-cloud
Spring Security
api手册地址：http://www.matools.com/api/spring-security
Spring中文版
api手册地址：http://www.matools.com/api/spring-zh
Struts 2最新版
api手册地址：http://www.matools.com/api/struts2
Taperstry
api手册地址：http://www.matools.com/api/taperstry
TensorFlow中文
api手册地址：http://www.matools.com/api/tensorflow
Tomcat
api手册地址：http://www.matools.com/api/tomcat
Ubuntu
api手册地址：http://www.matools.com/api/ubuntu
Velocity 1.7
api手册地址：http://www.matools.com/api/velocity
VelocityTools2.0
api手册地址：http://www.matools.com/api/velocity-tools
Vue Router中文参考
api手册地址：http://www.matools.com/api/vue-router
vue.js中文文档
api手册地址：http://www.matools.com/api/vuejs
XMLBeans
api手册地址：http://www.matools.com/api/xmlbeans
Yahoo UI中文版
api手册地址：http://www.matools.com/api/yui
Zend Framework中文版
api手册地址：http://www.matools.com/api/zend-framework
Zookeeper
api手册地址：http://www.matools.com/api/zookeeper
Spring Boot 2.X：集成 Swagger2 开发 API 文档（在线+离线）
相信很多后端开发在项目中都会碰到要写 api 文档，不管是给前端、移动端等提供更好的对接，还是以后为了以后交接方便，都会要求写 api 文档。而手写 api 文档的话有诸多痛点：
Swagger 就很好地解决了这个问题。
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。
访问 swagger-ui.html 进行接口在线测试
用于类，表示表示这个类是swagger的资源。属性如下：
用于方法，表示一个http请求的操作。属性如下：
用于方法、参数、字段说明；表示对参数的添加元数据。
用于类，表示对类进行说明，用于参数用实体类接受。
用于方法、字段，表示对model属性的说明或者数据操作更改。
用于类、方法、方法参数，表示这个方法或者类被忽略，不在swagger-ui.html上显示。
用于方法，表示单独的请求参数。
用于方法，包含多个 @ApiImplicitParam。
用于类或者方法，描述操作的可能响应。
用于方法，响应头设置。
添加依赖
转换工具类
使用测试 Controller
添加依赖
可以修改此处 html 和 pdf，通过 mvn asciidoctor:process-asciidoc 可以导出相应格式文件
执行 mvn asciidoctor:process-asciidoc 后再执行 mvn generate-resources，可在 targt/generated-docs 目录下生成 xml 格式文件 关于API在线文档及案例和api文档编写的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。 API在线文档及案例的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于api文档编写、API在线文档及案例的信息别忘了在本站进行查找喔。
版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。
相关文章
推荐文章
最近发表
