写java接口的文档工具_【java】适合写接口文档的工具,或者文本语法
由于后端与前端使用ajax交互,后端写接口文档变得非常有必要。以前我习惯用word写接口文档,但是最近与同事合作编写后端,word并不适合使用svn工具做同步,因为svn、git等无法自动合并word。所以打算把文档写成文本的格式。
一开始想到的是用markdown语法来写。markdown语法大全
但是接口文档最重要的一个特性是,接口多,需要给每个接口标序号(如下图)。
当然markdown支持序号,但是支持得并不完美,比如上下两个序号之间最多只能有一个空行,并且空行不能写文字,这样就只能光写接口标题了,没有空间写接口内容了。
请问适合写接口文档的方法是什么?最好就是一种语法,而不是一个软件
感谢大家的回答,考虑到markdown目前的趋势,还是决定继续使用markdown,现在已经想到解决办法,markdown只是一种语法,到底怎么显示,还是由软件或者浏览器插件来决定的,我找到两款chrome插件
Markdown Preview Plus
能自动把原文中的标题提取出来生成目录,并且能给目录自动加序号(如果原文标题本身就有序号,它也会加自己的序号,所以原文标题不能有序号)
Markdown Viewer
同样能把原文中的标题提取出来生成目录,但是不会加序号,对于不需要序号,或者接口较少的,可以用这个,我更喜欢这个插件的目录样式,可惜功能缺了一点。
这两款插件其实是提供给文档阅读者的,文档编辑者倒是可以不需要,全看个人喜好了,chrome官方市场里就找到这两款了,不知道国内有没有人开发了插件没传到chrome市场
回答
我推荐 RAML
目前一直在使用,采用 YAML 文件格式编写,强大的官方支持,官方提供 atom 插件,支持语法智能提示及校验,编写快速简单。
支持 examples
支持 schema 校验
支持工具测试
官方提供 API CONSOLE,支持渲染
DEMO APPLICATION
这一切都是免费开源的。
GitBook或者Swagger-UI都可以。比较推荐Swagger-UI,在写代码的时候添加注释即可生成文档。
选过去选过来 还是觉得使用postman要顺手一点 反正这东西都要手写 postman调试起来还方便
一直在用RAP,使用起来很简单RAP
工具的话可以在内网用MinDoc 接口文档在线管理系统搭一个文档管理系统,其功能和界面源于看云,
语法还是Markdown
序号可以以层级关系处理
postman
apidoc 还挺好用的
Swagger. 通过固定格式的注释生成文档. 省时省力
维护省事的就是:Swagger,不过学习成本有点
只是文档性的话,建议:gitbook或mkdocs(都支持markdown语法,和构建为html文件)
APIJSON自动化在线解析
完全自动生成文档,自动管理测试用例,不用写任何代码
http://39.108.143.172/
Showdoc挺好用的
我一般用MD来写,很简单,调用者一看就懂
用户注册
POST /user/register
请求参数
{
"username": "xxx"
}
成功响应
{
"errmsg": "ok",
"errcode": 0
}
失败响应
{
"errmsg": "ok",
"errcode": 0
}
有道云笔记也不错的
公告列表
接口地址:
g=Api&m=Banner&a=lists
返回说明
//正常返回的JSON数据包
{
"result": "ok",
"banners": [
{
"banner_id": "BANNER_ID",
"banner_name": "BANNER_NAME",
"image_url": "IMAGE_URL",
"target_url": "TARGET_URL",
"start_time": "START_TIME",
"end_time": "END_TIME",
"banner_type": "BANNER_TYPE",
"banner_sort": "BANNER_SORT"
}
]
}
写java接口的文档工具_【java】适合写接口文档的工具,或者文本语法相关推荐
- java接口文档生成工具_【分享】接口文档生成工具apipost
一.为什么要写接口文档? 正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要. 项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发 ...
- java接口测试工具_【分享】接口工具对比(apipost、jmeter、postman、swagger等)
一.接口都有哪些类型? 接口一般分为两种:1.程序内部的接口 2.系统对外的接口 系统对外的接口:比如你要从别的网站或服务器上获取资源或信息,别人肯定不会把 数据库共享给你,他只能给你提供一个他们写好 ...
- mysql 文档生成器_最好用的数据库文档生成工具
一 前言 本文介绍一些比较流行的数据库文档生成工具,什么是数据库文档? 其实在工作中进行项目交付的时候经常用到:简单来说数据库文档就是对整个数据库设计说明的文档,比如使用了哪个数据库,每张表的字段,类 ...
- vvv在线文档导出工具_胖观察在线协作文档导出之痛?主流协作文档导出评测
随着在线协作文档类工具越来越流行,不少教师也尝试通过文档协作的方式来开启线上作业反馈.作文批改互评,师生可以通过微信.浏览器就能实现以前需要在电脑前才能完成的文档输入工作,而且多人协作还能避免传统文档 ...
- 十三种技术文档模板_帮助企业制作帮助文档的6大“黑科技”工具!
在日常产品使用的过程中,经常会遇到一些操作上的问题而这时我们通常会翻阅产品的使用说明书,而对于线上的产品来说通常都会有帮助文档,帮助文档的作用就是对用户操作过程中遇到的种种问题做详细的解答,同时也是对 ...
- python pdf处理工具_用Python处理pdf文档
介绍 译者翻译了很多Python强大的包,其中,一以贯之的思想是:面向对象.我用下面的翻译来举一个例子,比如:从PyPDF2包中导入PdfFileReader包.PdfFileReader是此包的一个 ...
- python开发技术文档范文_程序员编写技术文档的新手指南
这是一篇帮助你给第一个项目写文档的指南. 万事开头难,我希望这份指南能把你引导到正确的道路上. 最后,你应该有一个可以公开发布的项目. 请轻松地阅读完这篇文章,或者简单地把它当作参考. 为什么要写文档 ...
- java excel 插件开发工具_程序员常用的15 种开发者工具推荐
程序员常用的15 种开发者工具推荐:Java 线上诊断工具 Arthas.IDE 插件 Cloud Toolkit.混沌实验注入工具 ChaosBlade.Java 代码规约扫描插件.应用实时监控工具 ...
- Java格式化日期用斜杠_[java工具类01]__构建格式化输出日期和时间的工具类
在之前的学习中,我写过一篇关于字符串格式化的,就主要设计到了时间以及日期的各种格式化显示的设置,其主要时通过String类的fomat()方法实现的. 我们可以通过使用不同的转换符来实现格式化显示不同 ...
- python 数据挖掘工具_推荐19款最常用的数据挖掘工具
数据在当今世界意味着金钱.随着向基于app的世界的过渡,数据呈指数增长.然而,大多数数据是非结构化的,因此需要一个过程和方法从数据中提取有用的信息,并将其转换为可理解的和可用的形式. 数据挖掘或&qu ...
最新文章
- 绘制E—R图(详细)
- MRuby 编译笔记
- LeetCode - Palindrome Number
- python 导入数据对不齐_NumPy:使用loadtxt或genfromtxt读取参差不齐的结构
- uni-app获取腾讯地图计算两经纬度的实际距离(可批量)
- Boring Partition(CF-239D)
- 微软未来将在其开发语言整合F#语言(2007-10)
- 带宽与虚拟桌面的考虑
- STC学习:扫描频率可变的电子钟
- 2021爱分析·时尚品牌数字化厂商全景报告
- SoftIce,IDA pro强强联合!从SOFTICE中打开IDA Pro输出的map信息文件
- java-家庭作业3
- 微信朋友圈+html+字体颜色,改变微信聊天字体颜色的方法?
- CodeForces 954A Diagonal Walking
- 支持华为鸿蒙2.0的手机型号是,华为鸿蒙2.0系统支持的手机型号 华为鸿蒙2.0系统详解...
- chrome浏览器被360流氓捆绑,如何解决?
- 哎,又跟HR在小群吵了一架!
- 怎么拦截网页上的广告以及新闻
- 【专利缴费信息网上补充_发票下载】
- Javascript 可选链