国产亚洲成人久久,亚洲精品无码久久不卡,一个色综合久久

本篇文章給大家?guī)?lái)了關(guān)于laravel的相關(guān)知識(shí)，其中主要介紹了swagger使用的相關(guān)問(wèn)題，下面一起來(lái)看一看基于laravel 生成swagger 為例子，希望對(duì)大家有幫助。

詳細(xì)了解Laravel Swagger的使用

【相關(guān)推薦：laravel】

swagger太辣雞了？

本教程是基于laravel 生成swagger 為例子，其實(shí)這個(gè)東西和語(yǔ)言或者和框架基本沒(méi)啥區(qū)別，因?yàn)槎际怯玫墓玫?a href="http://www.babyishan.com/tag/js">JSon ，通過(guò)程序掃描swagger預(yù)先規(guī)定的“語(yǔ)言”，生成結(jié)構(gòu)存入json中，通過(guò) swagger ui 展現(xiàn)出來(lái)（或者自己開(kāi)發(fā)）。

對(duì)于php開(kāi)發(fā)人員來(lái)說(shuō)，有大部分同學(xué)很不喜歡swagger。因?yàn)檫@個(gè)看上去寫(xiě)起來(lái)好麻煩啊，一想到分分鐘用php寫(xiě)完的代碼，寫(xiě)swagger要寫(xiě)10分鐘，心里就抵觸這個(gè)東西。

身邊有Java開(kāi)發(fā)的同學(xué)就知道他們很大一部分都用swagger，因?yàn)閖ava要維護(hù)數(shù)據(jù)結(jié)構(gòu)，而且swagger在java整合得更靈活。

這個(gè)時(shí)候java如果看到有php 說(shuō)swagger反人類(lèi)的東西，太麻煩了，上古時(shí)代的產(chǎn)物。那身邊的java朋友會(huì)心里竊喜，這么好用的東西都不用，還說(shuō)php是世界上最好的語(yǔ)言。

我為啥用swagger

最近在寫(xiě)自動(dòng)生成代碼，其實(shí)現(xiàn)在Laravel 很多自動(dòng)生成CURD的。比如像laravel-admin ，一條命令生成CURD，但是生成之后，數(shù)據(jù)看上去很冷。比如有一些字段不需要顯示，有一些是要select關(guān)聯(lián)枚舉的，有一些是 hasMany的，還有 overtrue（正超）的api腳手架也挺好的

所以swaager也可以根據(jù)業(yè)務(wù)需求寫(xiě)自動(dòng)化生成

L5-Swagger

https://github.com/DarkaOnLine/L5-Swagger

安裝：

composer require "darkaonline/l5-swagger"

使用：

php artisan vendor:publish --provider "L5SwaggerL5SwaggerServiceProvider" php artisan l5-swagger:generate

填寫(xiě)下面例子生成之后再訪問(wèn)

/api/documentation

@OAInfo 為必須

例子

/**  * @OAInfo(  *      version="1.0.0",  *      title="L5 OpenApi",  *      description="L5 Swagger OpenApi description",  *      @OAContact(  *          email="darius@matulionis.lt"  *      ),  *     @OALicense(  *         name="Apache 2.0",  *         url="http://www.apache.org/licenses/LICENSE-2.0.html"  *     )  * )  */

get 請(qǐng)求

如果要匹配path中的數(shù)值則 in path 查詢(xún) in query

/**  * @OAGet(  *      path="/projects/{id}",  *      operationId="getProjectById",  *      tags={"Projects"},  *      summary="Get project information",  *      description="Returns project data",  *      @OAParameter(  *          name="id",  *          description="Project id",  *          required=true,  *          in="path",  *          @OASchema(  *              type="integer"  *          )  *      ),  *      @OAResponse(  *          response=200,  *          description="successful operation"  *       ),  *      @OAResponse(response=400, description="Bad request"),  *      @OAResponse(response=404, description="Resource Not Found"),  *      security={  *         {  *             "oauth2_security_example": {"write:projects", "read:projects"}  *         }  *     },  * )  */

POST 請(qǐng)求

                   /**      * @OAPost(      *      path="/api/test/store",      *      operationId="api/test/store",      *      tags={"Test"},      *      summary="Test創(chuàng)建",      *      description="Test提交創(chuàng)建",      *      @OAParameter(      *          name="id",      *          description="",      *          required=false,      *          in="query",      *      ),      *     @OAResponse(      *         response=200,      *         description="successful operation",      *         @OAJsonContent(      *         ref="#/components/schemas/Test"      *         )      *     ),      *      @OAResponse(response=400, description="Bad request"),      *      @OAResponse(response=404, description="Resource Not Found"),      *      security={      *         {      *             "api_key":{}      *         }      *     },      * )      */

文件上傳參數(shù)

     *     @OARequestBody(      *       @OAMediaType(      *           mediaType="multipart/form-data",      *           @OASchema(      *               type="object",      *               @OAProperty(      *                  property="file",      *                  type="file",      *               ),      *           ),      *       )      *     ),

傳入為枚舉

     *     @OAParameter(      *         name="status",      *         in="query",      *         description="狀態(tài)",      *         required=true,      *         explode=true,      *         @OASchema(      *             type="array",      *             default="available",      *             @OAItems(      *                 type="string",      *                 enum = {"available", "pending", "sold"},      *             )      *         )      *     ),

Body 為Json 方式提交

     *     @OARequestBody(      *         @OAMediaType(      *             mediaType="application/json",      *             @OASchema(      *                 @OAProperty(      *                     property="id",      *                     type="string"      *                 ),      *                 @OAProperty(      *                     property="name",      *                     type="string"      *                 ),      *                 example={"id": 10, "name": "Jessica Smith"}      *             )      *         )      *     ),

詳細(xì)了解Laravel Swagger的使用

使用結(jié)構(gòu)Schema作為請(qǐng)求參數(shù)

     *     @OARequestBody(      *         description="order placed for purchasing th pet",      *         required=true,      *         @OAJsonContent(ref="#/components/schemas/UserModel")      *     ),

Schema的使用

/**  * @OASchema(  *      schema="UserModel",  *      required={"username", "age"},  *      @OAProperty(  *          property="username",  *          format="string",  *          description="用戶(hù)名稱(chēng)",  *          example="小廖",  *      ),  *      @OAProperty(  *          property="age",  *          format="int",  *          description="年齡",  *          example=1,  *          nullable=true,  *      )  * )  */

枚舉

一個(gè)枚舉單獨(dú)創(chuàng)建一個(gè)Schema

/**  * @OASchema(  *   schema="product_status",  *   type="string",  *   description="The status of a product",  *   enum={"available", "discontinued"},  *   default="available"  * )  */

映射到模型中的具體字段

 *      @OAProperty(  *     property="status",  *     ref="#/components/schemas/product_status"  *      ),

這樣前端開(kāi)發(fā)者就可以

關(guān)聯(lián)模型

和枚舉差不多，通過(guò)一個(gè)Property關(guān)聯(lián)模型

 *      @OAProperty(  *     property="user_detail",  *     ref="#/components/schemas/UserModel2"  *      ),

關(guān)聯(lián)模型和枚舉，可以自動(dòng)生成請(qǐng)求的參數(shù)和，返回的結(jié)構(gòu)
詳細(xì)了解Laravel Swagger的使用

返回為模型結(jié)構(gòu)

     *     @OAResponse(      *         response=200,      *         description="successful operation",      *         @OAJsonContent(      *             type="array",      *             @OAItems(ref="#/components/schemas/UserModel"),      *             @OAItems(ref="#/components/schemas/UserModel2")      *         )      *     ),

就比如那天前端小妹跟你說(shuō)，哥哥，支付狀態(tài)3代表什么，可能你很快的說(shuō)出了是某某狀態(tài)，但是問(wèn)你11是啥狀態(tài)，人都要沙雕了。
通過(guò)swagger 的Schema 能讓前端人員摸清后端的結(jié)構(gòu)信息，比如：

詳細(xì)了解Laravel Swagger的使用

各位，這些都可以自動(dòng)化編程，自動(dòng)生成的，工作效率不要太爽

多個(gè)合并Schema

/**  * @OASchema(  *   schema="UserModel",  *   allOf={  *     @OASchema(ref="#/components/schemas/UserModel2"),  *     @OASchema(  *       type="object",  *       description="Represents an authenticated user",  *       required={  *         "email",  *         "role",  *       },  *       additionalProperties=false,  *       @OAProperty(  *         property="email",  *         type="string",  *         example="user@example.com",  *         nullable=true,  *       ),  *     )  *   }  * )  */

驗(yàn)證提供outh2 和apikey 兩種方式，在存放全局配置中寫(xiě)入（也可以任意目錄中）

/**  * @OASecurityScheme(  *     type="apiKey",  *     in="query",  *     securityScheme="api_key",  *     name="api_key"  * )  */

在接口中添加

security={{"api_key": {}}},

這時(shí)，swagger Ui 會(huì)出現(xiàn)一個(gè)鎖一樣的東西

詳細(xì)了解Laravel Swagger的使用

可以輸入自己的Token，請(qǐng)求的時(shí)候會(huì)帶上token

詳細(xì)了解Laravel Swagger的使用
可以結(jié)合 Laravel 的自帶token驗(yàn)證，可以參考之前寫(xiě)的文章 Laravel guard 菊花守衛(wèi)者

更多使用方法可以查看官網(wǎng)例子： https://github.com/zircote/swagger-php/tree/master/Examples/petstore-3.0

可能遇到的問(wèn)題

線上環(huán)境如果訪問(wèn)不了，可能是你nginx 配置的問(wèn)題，因?yàn)椋琹aravel-swagger 是通過(guò)file_content_get() 的方式 echo 輸出js 的。而你的nginx 配置判斷，如果是 .js 或者css 是靜態(tài)文件，所以到不了index.php ，更執(zhí)行不了 file_content_get 函數(shù)了。可以參考nginx 配置:

charset utf-8; client_max_body_size 128M;  location / { 	try_files $uri $uri/ /index.php$is_args$args; }   location ~ .php$ { 	include fastcgi_params; 	fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; 	fastcgi_pass  php74:9000 這個(gè)換成你自己的; 	try_files $uri =404; }

【相關(guān)推薦：laravel】

? 版權(quán)聲明

文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載。

THE END