絕對實用教程：如何在PhalApi定製本身的在線文檔模板？

絕對實用教程：如何在PhalApi定製本身的在線文檔模板？

 

PhalApi官方的在線文檔，默認長這樣：

 
雖然有在線文檔可使用，但在實際狀況下，考慮到項目須要顯示本身的公司Logo、項目名稱，以及其餘一些樣式的調整，所以這時可使用自定義模板。
 
如何在PhalApi定製本身的在線文檔模板？？
實現起來很簡單，就像咱們平時開放網站頁面那樣，只須要把模板的路徑修改一下便可。
 
在線文檔共有兩份模板，分別是：
 
第1份：在線列表頁文檔模板

• 本地代碼路徑是：./vendor/phalapi/kernal/src/Helper/api_list_tpl.php
• 遠程代碼路徑是：https://github.com/phalapi/ker ... l.php

 
第2份：在線詳情頁文檔模板

• 本地代碼路徑是：./vendor/phalapi/kernal/src/Helper/api_desc_tpl.php
• 遠程代碼路徑是：https://github.com/phalapi/ker ... l.php

 
也就是說，若是你只是想改項目的模板，那麼就修改本地的； 若是你想分享給更多同窗，就能夠修改遠程的，而後提交PR。
 
如何修改本地的在線文檔列表頁模板？
首先，把本地模板複製一份，放到本身的項目中。建立一個新目錄 ./src/app/view，而後拷貝過去。

$ cp ./vendor/phalapi/kernal/src/Helper/api_list_tpl.php ./src/app/view/

 
而後，自由發揮，修改 ./src/app/view/api_list_tpl.php 模板中的內容或樣式。
例如，加一個頂部的菜單項，追加如下代碼：

<a href="https://www.phalapi.net/" class="item">PhalApi</a>
      <a href="http://docs.phalapi.net/#/v2.0/" class="item">文檔</a>
      <a href="http://qa.phalapi.net/" class="item">社區</a>

      <!-- 新加一個菜單 -->
      <a href="https://my.oschina.net/dogstar" class="item">dogstar的博客</a>

     <div class="right menu">

接着保存。 
最後，這一步很關鍵，就是告訴PhalApi切換到你本身的模板文件。修改 ./public/docs.php 文件，而後在render渲染時修改成本身的模板路徑。
例如，新加的菜單顯示效果是：


  

if (!empty($_GET['detail'])) {
    $apiDesc = new \PhalApi\Helper\ApiDesc($projectName);
    $apiDesc->render();
} else {
    $apiList = new \PhalApi\Helper\ApiList($projectName);
    $apiList->render(API_ROOT . '/src/app/view/api_list_tpl.php'); // 修改成本身的模板路徑
}

再訪問在線文檔，就能看到本身的模板啦！
 
如何修改本地的在線文檔接口詳情頁模板？修改在線詳情頁模板的作法和修改列表的相似，也是首先，複製一份：

$ cp ./vendor/phalapi/kernal/src/Helper/api_desc_tpl.php ./src/app/view/

而後，修改模板。
 
最後，切換模板。

if (!empty($_GET['detail'])) {
    $apiDesc = new \PhalApi\Helper\ApiDesc($projectName);
    $apiDesc->render(API_ROOT . '/src/app/view/api_desc_tpl.php');
 // 修改成本身的模板路徑
} else {
    $apiList = new \PhalApi\Helper\ApiList($projectName);
    $apiList->render(API_ROOT . '/src/app/view/api_list_tpl.php');
}

 

 小白接口的定製模板效果
例如，PhalApi官網的創新項目，小白接口的定製模板效果以下：

在線文檔連接是：http://pre.api.okayapi.com/docs.php?api=Ext.QrCode
 
如何分享本身的模板和主題？
若是有好的模板要和主題，歡迎在下方回覆留言，貼上源代碼的連接 ^_^