快速编写接口api规范文档工具(Markdown)

发布时间:2020-06-30 15:58:48 作者:开始51CTO
来源:网络 阅读:5111

在前端与后端分离开发的场景下、在外部需要提供的接口场景下,以及其他需要进行业务数据对接交互的场景下时,需要提供明确的接口功能说明及相关参数说明,此文档在分离开发下时,是必不可少的,现在通过编写.Mackdown(简称: .md)


Markdown 是一种轻量级标记语言,它允许人们“使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档

附件:

1、安装软件Haroopad

2、编写md的示例文档

1、安装编写md的工具:Haroopad 

2、打开工具


快速编写接口api规范文档工具(Markdown)



3、附件中是文档示例,更多操作,也可以通过“插入” 菜单下的功能进行操作

4、导出内容为html文档

     在右侧即时显示窗口,右键 ->


快速编写接口api规范文档工具(Markdown)

推荐阅读:
  1. showdoc使用笔记(自动生成api文档和数据库字典)
  2. Markdown快速入门

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

接口 编写 快速

上一篇:Android开发中关于摄像头方向的理解

下一篇:探究php的memcache和memcached扩展读写数组数据不相兼容原因

相关阅读

您好,登录后才能下订单哦!

密码登录
登录注册
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》