Swagger Info說明
上篇寫過Info，但是我們只寫了title 與 version ，其實還有一些可以做填寫，讓他顯示頁面上。
讓我們參考一下OpenApi官方的說明。
由此文件可以知道，只有兩個必填欄位，其他是可以選填的。
- version 文件版本號(必填)
- title 文件標題(必填)
- description 文件描述
- contact 聯絡資訊
- name 聯絡人稱呼
- email 聯絡人電子郵件
- url 聯絡人相關網頁
- termsOfService 服務條款相關連結
- license 關於你的API 相關的 License 說明路徑
- externalDocs 外部文件
- description 文件說明
- url 文件路徑
那其他欄位該如何填入呢?
/**
* @OA\Info(
* version="1.0.0",
* title="API文件",
* description="接口文檔",
* @OA\Contact(
* name="Travis",
* email="travis90736@hotmail.com",
* url="https://blog.travis.idv.tw",
* ),
* @OA\ExternalDocumentation(
* description="externaldoc2",
* url="https://example.com/externaldoc2/"
* ),
* termsOfService= "https://example.com/terms/",
* @OA\License(
* name="Apache 2.0",
* url="https://www.apache.org/licenses/LICENSE-2.0.html"
* ),
* )
*/以上輸入完畢後，再次使用發佈指令產出Json檔。
php artisan l5-swagger:generate然後就會看到以下畫面啦~
參考頁面