PHP は Swagger を使用して API ドキュメントを自動的に生成します

Swagger を使用して API ドキュメントを自動的に生成します

Swagger を使用して API ドキュメントを自動的に生成します。必要な友人はそれを参照できます。

1. swagger-ui をダウンロードし、サーバーに直接アップロードします

2. swagger-php をダウンロードし、ドキュメントに従ってインストールします

3. コメントコードを追加しますPHP ファイル

/** 
* @SWG/Resource ( 
* apiVersion = "版本号", 
* basePath = "API地址", 
* resourcePath ="项目名称", 
* @SWG/Api ( 
* path = "API文件名", 
* description = "功能描述", 
* @SWG/Operation ( 
* method="POST", summary="操作描述", nickname = "显示名", 
* @SWG/Parameter (name="参数名", description="参数说明", required = true, paramType = "query", type="string"), 
* @SWG/ResponseMessage (code=200, message="返回说明") 
* ) 
* ) 
*) 
*/

4. swager-php を使用して JSON アドレスを生成します

php ../composer/vendor/zircote/swagger-php/swagger.phar /apifolder -o / docfolder

5. swagger-ui のデフォルト データ アドレスを変更

6. 完了