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

Posted 2020-10-10

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

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

附件：

1、安装软件Haroopad

2、编写md的示例文档

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

2、打开工具

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

4、导出内容为html文档

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

本文出自 “FROG清” 博客，请务必保留此出处http://wuxueqing.blog.51cto.com/13389311/1972073