phpapi文檔生成

❶ phpstorm自動生成方法注釋規則配置

首先你得安裝好java以及配置好環境變數，能在cmd裡面運行java。win+R彈出運行窗口輸入cmd回車，進入dos界面，輸入java-version，檢查java是否配置好。
配置好java後，我們新建一個含有公共類的java文件，在裡面隨便寫點東西。然後保存到文件夾test裡面，在文件夾裡面空白處，按住shift鍵，然後點擊滑鼠右鍵，出現：在此處打開命令窗口，點擊進入命令窗口，然後輸入javadoc（空格）DemoA.java，回車，會跳出正在生成api注釋文檔，我們點擊index.html即可查看文檔。
PHPSTORM的快速生成注釋的方法：設置頭部注釋、類注釋以及函數注釋，時間、用戶名、文件名稱等隨機改變的屬性，直接使用其下方已經定義的屬性即可。生成注釋，輸入」/**，「按」enter「鍵即可出現對應注釋內容。

❷ 如何使用PhpDocumentor生成文檔

命令行方式：
在phpDocumentor所在目錄下，輸入phpdoc –h會得到一個詳細的參數表，其中幾個重要的參數如下：
-f 要進行分析的文件名，多個文件用逗號隔開
-d 要分析的目錄，多個目錄用逗號分割
-t 生成的文檔的存放路徑
-o 輸出的文檔格式，結構為輸出格式：轉換器名：模板目錄。
例如：phpdoc -o HTML:frames:earthli -f test.php -t docs
Web界面生成
在新的phpdoc中，除了在命令行下生成文檔外，還可以在客戶端瀏覽器上操作生成文檔，具體方法是先把PhpDocumentor的內容放在apache目錄下使得通過瀏覽器可以訪問到，訪問後顯示如下的界面：
點擊files按鈕，選擇要處理的php文件或文件夾，還可以通過該指定該界面下的Files to ignore來忽略對某些文件的處理。
然後點擊output按鈕來選擇生成文檔的存放路徑和格式.
最後點擊create，phpdocumentor就會自動開始生成文檔了，最下方會顯示生成的進度及狀態，如果成功，會顯示
Total Documentation Time: 1 seconds
done
Operation Completed!!
然後，我們就可以通過查看生成的文檔了，如果是pdf格式的，名字默認為documentation.pdf。
給php代碼添加規范的注釋
PHPDocument是從你的源代碼的注釋中生成文檔，因此在給你的程序做注釋的過程，也就是你編制文檔的過程。
從這一點上講，PHPdoc促使你要養成良好的編程習慣，盡量使用規范，清晰文字為你的程序做注釋，同時多多少少也避免了事後編制文檔和文檔的更新不同步的一些問題。
在phpdocumentor中，注釋分為文檔性注釋和非文檔性注釋。
所謂文檔性注釋，是那些放在特定關鍵字前面的多行注釋，特定關鍵字是指能夠被phpdoc分析的關鍵字，例如class，var等，具體的可參加附錄1.
那些沒有在關鍵字前面或者不規范的注釋就稱作非文檔性注釋，這些注釋將不會被phpdoc所分析，也不會出現在你產生的api文當中。

❸ php如何開發API介面

比如一個自定義函數：function test(){echo 『hello world』;}就可以叫做 api。api 既可以是單個的函數，也可以是封裝在類里的方法，當然它們也是程序代碼。開發一個 api 的流程可以很簡單，也可以很復雜，視具體的編程任務而決定，並沒有特定的規則。比如，你需要為自己建立一個常用的函數庫，命名為 my.lib.php然後把你自己編寫的自定義函數，全部寫在這個文件裡面，那麼，你就擁有了自己的api。開發的時候，只需要引入 my.lib.php，你就可以調用自己的 api 了。這是一個比較簡單的例子。稍微復雜一點的，你可以把函數封裝在類裡面，方便繼承和重用，還可以根據函數名稱做一些程序設計，這個一句話說不清楚，給一個簡單的例子吧：class mylib{function showmy(){echo 『這是我的一個類方法』;}}調用的時候，先要實例化類，然後再調用方法。再復雜一點的就是使用類介面，區別就是介面裡面定義的只是方法原型，而你需要通過具體的類來實現介面中的函數，具體請參考 php 手冊

❹ PHP調用API，有對接文檔，有KEY，我是新手，不知道怎麼寫，請高手賜教！

使用curl訪問或者file_get_contends訪問，

$url = 'http://fire.ym0613.top/api/v1/channel/task/grap?key=&prov=你接單的省份&tid=你得任務id';

$jsons = file_get_contents($url);
$jsons = json_decode($jsons,true);
echo '<pre>';
print_r($jsons);
exit;

❺ 如何生成RestFul Api文檔

還是喜歡使用WisdomToolRESTClientV1.1支持自動化測試RESTfulAPI和自動生成RESTfulAPI文檔

工具地址：

https://github.com/wisdomtool/rest-client/

❻ 如何生成rest api文檔

轉載
構建web可訪問應用編程介面很簡單，但使之良好工作，而且不間斷卻不簡單，Les Hazlewood在2013年JavaOne大會上如此說，他是Stormpath的首席技術官。Hazlewood在大會上展示了通過JAX-RS和Jersey構建美好的REST+JSON API的最佳實踐。
「表面看來，良好的REST API很簡單，即使後端很復雜，」 Hazlewood在一次采訪說到。一個API關注一系列的東西，以及如何表現個人的東西。減少API集合，搜索所有書籍和出版刊物，你會發現一個簡潔的解決方案，它很直觀，且不是太復雜。
在本文中，Hazlewood深入打探討了API最佳實踐、REST API和JSON的優缺點等等。
使用REST API時，什麼是開發人員需要探索的？
Les Hazlewood：REST作為架構式構建存在於HTTP的最頂層虎琺港貉蕃股歌癱攻凱。你交換數據的方式、你創建、讀取、更新和刪除數據的語義都建立在HTTP規范之內。REST是用於編纂當交換跨分離機器創建讀取-刪除時的工作環境如何。
這就是REST，編纂這些跨分離機器的行為發生的方式。因為它依賴於HTTP，我可能有一台Linux機器，它可以與Windows機器時行對話，也可以與Mac機對話。它並不是平台或廠商特定的。因為HTTP無處不在，所以REST就無處不在。所有語言（Python、PHP、Java和C#）都可以與REST一起工作。
REST簡化了所有方面。所有人都以為他們了解了HTTP。這正是你的瀏覽器所講的東西。他們知道HTTP協議、知道GIT、知道POST，因為他們多年以來一直在填寫web表單。所以因為REST只使用HTTP，開發人員就認為它很簡單，但是現在REST服務越來越多，而不是XML，它融匯的SOAP。
使用REST的難點在哪？
Hazlewood:：這正是我要做的演講原因。REST是架構樣式，但是使用它的方法論還沒有正式的標准和規范。用樣式來解釋一下。我認為它的運行方式可能會與你以為稍微有點不同。因為它不是一個機器可以復制的規范，這里摻入了人為的因素。把東西變得簡單易用的漏洞往往都不簡單。REST和JOSN很簡單。HTTP很簡單。但要確保使用兩者解決問題時，要直觀，而不是隨處都可編碼化。
你推薦JSON和REST一起使用的其它原因還有什麼？
Hazlewood：REST和JSON提供了與人友好的數據表述方法；數據不再像XML那樣擁擠；你的肉眼就可以很容易看到。這一直都是廣泛採用JSON的原因。
JSON是語法規范。它只是定義了基本的字元串、數字、空值、非空值。它允許你以一種簡單的模式表述復雜的事情，而且以最小的元數據量。它如此的篇章，可以用於許多不同的環境中。機器很容易對其進行解析。人們也很容易閱讀。
JavaScript是世界上一個佔有重要位置的編程語言。即使主要的應用是由Java、Python或C#構建的，比重也很高，如果你有一個網頁，或一個可視的用戶界面，那麼就會涉及到一些JavaScript。JSON與JavaScript兼容。所有具備JavaScript編程經驗的人都會發現他們很容易就會了解JSON。如果你已經使用了JavaScript，那就能很輕松地與API集成。如果API返回給JSON，而且你已經編寫的JavaScript，那麼你的編程語言就已經知道如何與返回給伺服器的數據進行交互。JSON使用JavaScript進行數據交換，而不只是編寫軟體，這在當前已經很流行了，
什麼時候使用JSON正確，什麼時候錯誤？
Hazlewood：顯然，XML在結構化表述數據上更好。XML文檔中包含更多的信息，類型在XML文檔中表述會更有效。XML非常適合數據交換，但易用性方面卻使用開發者猶豫了。JSON用肉眼就可以檢查。XML在設計上更復雜。JSON是非常簡單的語法。談到語言設計，JSON只構建了一小部分的核心元素，而且一切都源於這一小部分元素。因為它的簡單性，它很容易操作，也很容易理解。與XML相比，JSON並不是很適合機器消化信息。從這點來看，XML就會做的更好。

❼ phpstrom怎麼生成api

windows下按下快捷`Ctrl`+`Shift`+`+`，這樣就能恢復打開所有代碼了。 這樣再單獨打開需要查看幾個方法就方便多了，

❽ 如何使用go-swagger 生成Api文檔

看來你還沒理解maven，maven的設計思想之一是」約定優於配置「，最大優勢在於」依賴管理「。archetype這個插件裡面就是內置了一些app,web-app的類型，maven把他認為的最佳實踐都內置好了，你所做的是按照約定把該放的東西放到位置，當然你也可以像你說的把一些代碼改地方，你可以仔細研究一下archetype插件的文檔中一些參數，不過maven官方不推薦改動，因為大家都遵循差不多的規定，然後在pom.xml裡面很簡單的就配置好依賴關系，工程的擴展就容易了。maven希望是你把你的工程源代碼按照maven建好的目錄進行組織即可，如果這些不適合，你可以再看看其他插件里有沒有合適的。你要是那樣用，還不如用ant，怎麼設置工程是活的，maven並不是取代ant，只是它用了另一套哲學。不知道你認同否

❾ api文檔怎麼寫 api介面我已經寫好了但時文檔不太會寫 還有編寫api文檔有什麼作用 請各位高手大蝦指點迷津

很多擴展類，框架。PHP有第三方的函數庫。DELPHI則是控制項。其實這體現了「軟體工程」中代碼重用的思想。任何好的，工業生產級別的語言都會有很多的擴展支持的。如果，每個體統都需要從底層一點一點的敲代碼。是很浪費的。DELPHI整個體系的思想是很優秀的。被很多語言工具借鑒。比如.NET。而且DELPHI是開源的。這些控制項，都是優秀的學習資料。 祝你好運

❿ swagger ui 怎麼生成php開發的api文檔

Swagger --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.2.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.2.2</version> </dependency> <!-- END Swagger -->這樣呢，如果不行的話你可以直接去後盾人線下面授培訓問問那些專家講師，他們很樂意幫你的，希望能幫到你，給個採納吧謝謝，(ง •̀_•́)ง