首頁  >  文章  >  php框架  >  thinkphp5整合式Swagger-PHP(排坑)

thinkphp5整合式Swagger-PHP(排坑)

藏色散人
藏色散人轉載
2020-09-07 09:22:533617瀏覽

下面由thinkphp教學專欄為大家介紹thinkphp5整合Swagger-PHP(排坑),希望對需要的朋友有幫助!

thinkphp5整合式Swagger-PHP(排坑)

學習 Swagger 過程中發現網路上大部份的資料都不是特別全,所以特別發文把自己的排坑歷程寫出來,希望能對大家有幫助。

1、安裝swagger-php2.0

(註:我下載的是swagger-php2.0,本文針對swagger-php2.0)

composer require zircote/swagger-php: 2.0.*

2、下載swagger-ui

去swagger-ui官網下載靜態頁面,把靜態頁面放到thinkphp框架目錄裡,例如public目錄。

https://swagger.io/tools/swagger-ui/

3、thinphp框架引入swagger-php,產生swagger.json檔案

use Swagger\Annotations as SWG;
class Index
{
public function index()
{
$swagger=\Swagger\scan(__DIR__);
$res=$swagger->saveAs('./swagger.json');
}

4、文件註解部分

/**
* @SWG\Swagger(
* schemes={"http"},
* host="www.tp.com.cn/",
* basePath="/",
* @SWG\Info(
* title="API文档",
* version="1.0.0",
* )
* ),
*/

詳細關於Swgger-php的使用說明請訪問

https://www.kancloud.cn/chengguang/swagger-php#/catalog

以上是thinkphp5整合式Swagger-PHP(排坑)的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述:
本文轉載於:segmentfault.com。如有侵權,請聯絡admin@php.cn刪除