PHP如何使用Swagger生成好看的API文檔

本文小編為大家詳細介紹“PHP如何使用Swagger生成好看的API文檔”，內容詳細，步驟清晰，細節處理妥當，希望這篇“PHP如何使用Swagger生成好看的API文檔”文章能幫助大家解決疑惑，下面跟著小編的思路慢慢深入，一起來學習新知識吧。

一、安裝swagger-php

composer require zircote/swagger-php

swagger-php提供了命令行工具，所以可以全局安裝，然后把工具的路徑加到PATH里去。

composer global require zircote/swagger-php

然后把zircote/swagger-php/bin 目錄加到PATH里。這個東西本人用不到，就不研究了。

二、設置一個輸出api文檔數據的接口

a）、生成一個控制器： SwaggerController

b）、添加一個方法： getJSON()

    public function getJSON()
    {
        $swagger = \OpenApi\Generator::scan([app_path('Http/Controllers/')]);
        return response()->json($swagger, 200);
    }

有的文章里寫 \Swagger\scan()，但我這里報錯，說找不到這個類。查了官方文檔，要用 \OpenApi\Generator::scan()。有可能是新版本做了修改。

c）、設置路由

api.php 或者 web.php都行，路徑不同而已。本人選擇api.php。所以訪問路徑要加個前綴：/api。

Route::group(['prefix' => 'swagger'], function () {
    Route::get('json', [\App\Http\Controllers\SwaggerController::class, 'getJSON']);
});

d）、測試訪問

訪問 http://localhost:8000/api/swagger/json 如果看到頁面正常輸出json，說明配置成功了。不然就按錯誤提示一項項去修改吧。

三、使用

GET方法

    /** 
     * @OA\Get(
     *     tags={"數據管理"},
     *     summary="數據查詢",
     *     path="/api/data/search",
     *     @OA\Response(response="200", description="Display a listing of projects."),
     *     @OA\Parameter(
     *         description="數據名稱",
     *         in="query",
     *         name="name",
     *         required=false,
     *         @OA\Schema(type="string"),
     *     ),
     *     @OA\Parameter(
     *         description="狀態",
     *         in="query",
     *         name="status",
     *         required=false,
     *         @OA\Schema(type="integer"),
     *     ),
     *     @OA\Parameter(
     *         description="每頁記錄數",
     *         in="query",
     *         name="page-size",
     *         required=false,
     *         @OA\Schema(type="integer"),
     *     ),
     *     @OA\Parameter(
     *         description="當前頁碼",
     *         in="query",
     *         name="current-page",
     *         required=false,
     *         @OA\Schema(type="integer"),
     *     ),
     * )
     */

這里面:

in 表示該參數出現在哪里。 query的話就是用&拼在url后面; path 類似于 /api/data/search/{param} ; header就是包含在 request header里；cookie 自然是放在cookie里。

這個版本里formData, body這些都沒有了。

required 看名字就知道 true是必填項，false是選填項。

POST方法

    /** 
     * @OA\Post(
     *     tags={"數據管理"},
     *     summary="添加數據",
     *     path="/api/data",
     *     @OA\Response(response="200", description="Display a listing of projects."),
     *     @OA\RequestBody(
     *         @OA\MediaType(
     *             mediaType="x-www-form-urlencoded",
     *             @OA\Schema(
     *                 ref="#/components/schemas/DataModel",
     *             ),
     *         ),
     *     ),
     * )
     */

因為本人的前端代碼post都是表單提交，所以這里的post方法要用@OA\RequestBody。

@OA\Parameter是參數，是可以放到url上，但是post的表單提交，數據是不出現在url上的。

@OA\MediaType 這個: x-www-form-urlencoded 表單提交；application/json 提交json格式的數據；multipart/form-data 文件上傳；

     *             @OA\Schema(
     *                 ref="#/components/schemas/DataModel",
     *             ),

這個是關聯到一個已經定義好的schema上，省得使用相同數據的每個接口注釋里都寫一遍。

這里也可以單獨寫：

 * @OA\Schema(
 *   required={"name", "code"},
 *   @OA\Property(property="name", type="string", title="姓名", description="這是姓名"),
 *   @OA\Property(property="code", type="string", title="代碼", description="這是代碼"),
 *   @OA\Property(property="phone", type="string", title="電話", description="這是電話"),
 * ),

上面這樣，有多少個參數就寫多少個@OA\Property。這里的required是個數組，寫在里面的都是必填項。

四、顯示swagger ui

解壓后，把目錄里的dist目錄，復制到laravel的public目錄下面，改名為swagger-ui。文件名隨便取，不沖突就行。

找開這個swagger-ui目錄下的swagger-initializer.js，內容大概如下：

window.onload = function() {
  //<editor-fold desc="Changeable Configuration Block">
  // the following lines will be replaced by docker/configurator, when it runs in a docker-container
  window.ui = SwaggerUIBundle({
    url: "/api/swagger/json",
    dom_id: '#swagger-ui',
    deepLinking: true,
    presets: [
      SwaggerUIBundle.presets.apis,
      SwaggerUIStandalonePreset
    ],
    plugins: [
      SwaggerUIBundle.plugins.DownloadUrl
    ],
    layout: "StandaloneLayout"
  });
  //</editor-fold>
};

主要是改 url這項。改成前面設的路由地址。這里是 "/api/swagger/json"。完成后訪問 http://localhost:8000/swagger-ui/ 就能看到swagger形成的api文檔了。

讀到這里，這篇“PHP如何使用Swagger生成好看的API文檔”文章已經介紹完畢，想要掌握這篇文章的知識點還需要大家自己動手實踐使用過才能領會，如果想了解更多相關內容的文章，歡迎關注億速云行業資訊頻道。