1. 程式人生 > >快速編寫接口api規範文檔工具(Markdown)

快速編寫接口api規範文檔工具(Markdown)

編寫 快速 接口

在前端與後端分離開發的場景下、在外部需要提供的接口場景下,以及其他需要進行業務數據對接交互的場景下時,需要提供明確的接口功能說明及相關參數說明,此文檔在分離開發下時,是必不可少的,現在通過編寫.Mackdown(簡稱: .md)


Markdown 是一種輕量級標記語言,它允許人們“使用易讀易寫的純文本格式編寫文檔,然後轉換成有效的XHTML(或者HTML)文檔

附件:

1、安裝軟件Haroopad

2、編寫md的示例文檔

1、安裝編寫md的工具:Haroopad

2、打開工具


技術分享



3、附件中是文檔示例,更多操作,也可以通過“插入” 菜單下的功能進行操作

4、導出內容為html文檔

在右側即時顯示窗口,右鍵 ->


技術分享

本文出自 “FROG清” 博客,請務必保留此出處http://wuxueqing.blog.51cto.com/13389311/1972073

快速編寫接口api規範文檔工具(Markdown)