[TOC] > [demo](https://www.showdoc.cc/demo?page_id=7) > [home](https://www.showdoc.com.cn/) > [github](https://github.com/star7th/showdoc) ## 概述 >[warning] 此文件需要使用外網或docker搭建環境,通過api_key與api_token才能使用,不夠純粹 1. 可以導出 word 2. 頁面可保存為模版 3. 有api 模版與字典模版 4. 有團隊管理 5. ldap接入數據 6. 多項目管理 7. makedown形式的編寫 8. [自動生成API文檔 ](https://www.showdoc.cc/page/741656402509783) 9. 可以腳本或者docker 安裝 10. 在代碼生成文檔 ``` docker pull star7th/showdoc docker run -d --name showdoc -p 4999:80 -v /showdoc_data/html:/var/www/html/ star7th/showdoc ``` ## 特點 ### 可訪問局域網接口自動生成文檔 需要現在入口文件配置 如 php ``` header("Access-Control-Allow-Origin: *"); header("Access-Control-Allow-Credentials : true"); header("Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Connection, User-Agent, Cookie"); ```   ## 通過代碼實現生成接口生成文檔 > [參考文檔](https://www.showdoc.cc/page/102098) 1. 下載[showdoc_api.sh](https://www.showdoc.cc/script/showdoc_api.sh) 并配置 文件內容,api_key與api_token ``` api_key="ca28bcee7ceb2a7e16089b6b10d2290f986959735" #api_key api_token="d40ab971a70cbab6c6001863f04e50421453112241" #api_token url="http://192.168.0.188:4999/server/?s=/api/open/fromComments" #同步到的url。使用www.showdoc.cc的不需要修改，使用開源版的請修改 ``` 2. window 下需要 git-bash 3. 下載[測試文件](https://www.showdoc.cc/script/api_demo.test) 測試文件說明 ``` /** * showdoc * @catalog 測試文檔/用戶相關 * @title 用戶注冊 * @description 用戶注冊的接口 * @method post * @url https://www.showdoc.cc/home/user/login * @param username 必選 string 用戶名 * @param password 必選 string 密碼 * @param name 可選 string 用戶昵稱 * @return {"error_code":0,"data":{"uid":"1","username":"12154545","name":"吳系掛","groupid":2,"reg_time":"1436864169","last_login_time":"0"}} * @return_param groupid int 用戶組id * @return_param name string 用戶昵稱 * @remark 這里是備注信息 * @number 99 */ public function register(){ //code } ``` ``` @catalog 測試文檔/用戶相關 目錄路徑,不存在則會創建目錄 @title 用戶注冊 接口名 @number 99 排序 ``` 運行 ``` ./showdoc_api.sh ./showdoc_api.sh /myapp/demo/ ```