一直想找一套開源程式來寫介面文件,看過showdoc,swagger之類的,感覺都不是很方便 ,後來發現還是用markdown寫技術介面文件比較方便!

寫md檔案推薦使用gitbook 下載地址 https://www.gitbook.com/editor/ ,通過gitbook寫的檔案可以單獨放個目錄中,目錄如下

—doc
——使用者中心
———-登入.md
———-註冊.md
目錄檔案寫好,如何通過url方式檢視這些文件呢
這時可以引入mdjs,https://github.xuexb.com/mdjs/ 通過這個外掛可以輕鬆的實現通過網頁的模式訪問這些文件

1 使用這個外掛前要安裝nodejs apt-get install nodejs

2 然後進入 doc目錄,執行命令 npm install mdjs –save 這條命令執行前可以先執行npm init,

npm install mdjs –save執行完成後,會在當前目錄下生成node_modules,這個包是執行時需要的(暫且這麼說吧)

3 在有md檔案的目錄中加入index.js 檔案的內容如下所示:

'use strict';

var Mdjs = require('mdjs');

// 例項化
var app = new Mdjs({
    // 本地開發啟動debug則不快取檔案
    debug: true,
    name:'介面文件演示',
    ignore_dir: [
        '.svn'
 
,
        '.git',
        'node_modules'
    ],
    links: [
        {
             "text": "mdjs基本配置",
             "url": "https://github.xuexb.com/mdjs/options.md",
         },
    ],
});

// 清空快取
app.clear_cache();

// 執行跑起來
app.run();

接下來是要通過nodejs來執行index.js檔案 nodejs index.js,執行這個命令後可以通過
http://127.0.0.1:8091/