hyperf 註解文件生成

laravel02140011發表於2020-05-31

根據註解生成 API 文件

# 類的註解  分組
use Fyfyu\Swagger\Annotation\Api;
# 方法的註解 介面描述
use Fyfyu\Swagger\Annotation\ApiOperation;
# 引數組的註解
use Fyfyu\Swagger\Annotation\ApiParams;
# 引數的註解
use Fyfyu\Swagger\Annotation\ApiParam;

引數說明

註解 引數名稱 說明 預設值
Api name 分組名稱
ApiOperation name 介面名稱
ApiOperation describe 介面描述
ApiOperation version 介面版本 1.0.0
ApiParams value 引數 ApiParam 陣列
ApiParam paramType 引數型別 query 普通引數 header 頭引數
ApiParam name 引數名
ApiParam describe 引數描述
ApiParam type 引數型別 integer string ….
ApiParam defaultValue 預設值
ApiParam required 是否必填 true or false

安裝

    composer require fyfyu/hyperf-swagger

栗子

<?php

use Fyfyu\Swagger\Annotation\Api;
use Fyfyu\Swagger\Annotation\ApiOperation;
use Fyfyu\Swagger\Annotation\ApiParams;
use Fyfyu\Swagger\Annotation\ApiParam;
/**
 * @Api(name="測試組名稱")
 */
class IndexController extends AbstractController
{
    /**
     * @GetMapping(path="login")
     * @ApiOperation(name="登入",describe="測試用的介面描述資訊",version="1.0.0")
     * @ApiParams({
     *      @ApiParam(name="username",type="string",describe="使用者名稱 "),
     *      @ApiParam(name="password",type="string",describe="使用者的密碼 ")
     * })
     */
    public function login()
    {
        return $this->response->success();
    }
    /**
     * @PostMapping(path="logout")
     * @ApiOperation(name="退出",describe="使用者登出系統",version="1.0.1")
     * @ApiParam(name="authorization",type="string",describe="使用者登入時返回的 token")
     */
    public function logout()
    {
        return $this->response->success();
    }
}

 php bin/hyperf.php swagger:gen

訪問 //:domain/swagger[/server]

server 是 server.php 中配置的 預設 http

輸入圖片說明
輸入圖片說明

本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章