Laravel swagger
閱讀時間約 5 分鐘
我對於自己開發的API會習慣性寫一份swagger文件方便前端串接，但因為這些文件都是存在我個人的swagger帳號，且會受限於免費版限制，再加上剛好跟PM在討論如何維護我們的文件，於是我就開始著手將swagger自己部署到公司管理後台。
這樣做的好處：
(1)後端都可以編輯
(2)文件隸屬於公司底下且不用另外付費
(3)git版控，可以清楚知道誰動了什麼
實作
安裝
npm install swagger-ui
設定
step1: 存放yaml檔
因為這份swagger是要開放給外界看到的，所以會需要將檔案放在public資料夾，因為公司有多個產品，所以我開的路徑為：public/documents/aaa-api.yaml, public/documents/bbb-api.yaml
step2: js檔設定檔
在resource/js資料夾中新增每一份yaml檔要用的js設定：
aaa-swager.yaml
import SwaggerUI from "swagger-ui";
import "swagger-ui/dist/swagger-ui.css";
SwaggerUI({
dom_id: "#swagger-api", // 代表他會去找html中元素id是swagger-api的，然後將文件載入
url: "https://xxxxxx/documents/aaa-api.yaml", // yaml檔位置，js會去抓
});
bbb-swagger.yaml
import SwaggerUI from "swagger-ui";
import "swagger-ui/dist/swagger-ui.css";
SwaggerUI({
dom_id: "#swagger-api", // 代表他會去找html中元素id是swagger-api的，然後將文件載入
url: "https://xxxxxx/documents/bbb-api.yaml", // yaml檔位置，js會去抓
});
step3: webpack
設定
到webpack.mix.js檔，新增以下
mix.js("resources/js/aaa-swagger.js", "public/js")
.js("resources/js/bbb-swagger.js", "public/js")
運行
npm run dev將在resource/js資料夾的js打包到public/js資料夾裡，這樣我們的html檔就能載入他們，背後js會幫我們根據設定檔把畫面載入到某一個div上。
step4: 寫blade樣板
新增swagger.blade.php
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>api</title>
</head>
<body>
<div id="swagger-api"></div>
<script src="{{ mix('js/' . $fileName) }}"></script>
</body>
</html>
因為每一份api文件樣式都一樣，所以我才只開一份blade，需要載入的檔案位置再透過api route傳就好。
step5: route
到web.php新增以下路由：
Route::group([
'prefix' => 'documents',
'middleware' => ['auth:sanctum'] // 登入驗證,避免api公開
], function(){
Route::get('/aaa', function () {
return view('swagger')->with('fileName', 'aaa-swagger.js');
}); Route::get('/bbb', function () {
return view('swagger')->with('fileName', 'bbb-swagger.js');
});});
step6:開cors
step7: 運行
composer artisan optimize之後到你設定好的路由，就可以看到成果了
留言0
查看全部
你可能也想看
1.加權指數與櫃買指數
週五的加權指數在非農就業數據開出來後，雖稍微低於預期，但指數仍向上噴出，在美股開盤後於21500形成一個爆量假突破後急轉直下，就一路收至最低。 台股方面走勢需觀察週一在斷頭潮出現後，週二或週三開始有無買單進場支撐，在沒有明確的反轉訊號形成前，小夥伴盡量不要貿然抄底，或是追空
重點摘要：
1.9 月降息 2 碼、進一步暗示年內還有 50 bp 降息
2.SEP 上修失業率預期，但快速的降息速率將有助失業率觸頂
3.未來幾個月經濟數據將繼續轉弱，經濟復甦的時點或是 1Q25 季底附近
近期的「貼文發佈流程 & 版型大更新」功能大家使用了嗎？
新版式整體視覺上「更加凸顯圖片」，為了搭配這次的更新，我們推出首次貼文策展 ❤️
使用貼文功能並完成這次的指定任務，還有機會獲得富士即可拍，讓你的美好回憶都可以用即可拍珍藏！
紀錄一下Laravel好用的validator。
E
本筆記參考:
1. https://stackoverflow.com/questions/31539727/laravel-password-validation-rule
續上篇，把程式碼改成這樣，model加上關聯，就可以從article去query comments了。
L27表示從article table中primary key = 1的文章去找所有留言。
L27的$articles變數output如下:
L12這個method: comments()，
假如開發了一個部落格，以下是ERD設計:
接著從程式碼來看如何join:
$this->article
->join('comments', 'article.article_id', '=', 'comments.article_id')
->select('article.article_i
在開發過程中，難免會需要自己寫一些common function，例如Laravel 如何寫 Log這篇提到的，write log為了能夠顯示file name跟line，可以把它封裝成一個common function，以後要改log format也只需要從這邊改...
Laravel的日誌系統底層是Monolog，設定在config\logging.php裡面，預設路徑是在storage\logs\laravel.log，也可以更改成喜歡的路徑。
...
Laravel本身是MVC架構的Framework，但隨著專案越來越龐大，若不把系統架構分工再切細一點，可能會導致日後維護的困難。
例如可能會很常發生controller要與model溝通拿資料，又要處理商業邏輯，就會導致controller越來越肥，因此本文要介紹的是....
本筆記遵循官方文件教學，經過一些小修改，經測試可以跑在Laravel Framework version: 8.13.0，將筆記記錄下來。
......
本文模擬user註冊的情境來簡單演示，在Laravel中如何透過ajax來存取資料，以post request為例。
前端透過post把user資料送到controller中，並且透過model把資料塞進DB，最後回傳json response。
完整source cod
Laravel Framework version: 8.12.3
本範例做了兩個，一個是進到首頁顯示hello world!，另一個是進到article頁面時，從資料庫把文章抓出來顯示。
...
1.加權指數與櫃買指數
週五的加權指數在非農就業數據開出來後，雖稍微低於預期，但指數仍向上噴出，在美股開盤後於21500形成一個爆量假突破後急轉直下，就一路收至最低。 台股方面走勢需觀察週一在斷頭潮出現後，週二或週三開始有無買單進場支撐，在沒有明確的反轉訊號形成前，小夥伴盡量不要貿然抄底，或是追空
重點摘要：
1.9 月降息 2 碼、進一步暗示年內還有 50 bp 降息
2.SEP 上修失業率預期，但快速的降息速率將有助失業率觸頂
3.未來幾個月經濟數據將繼續轉弱，經濟復甦的時點或是 1Q25 季底附近
近期的「貼文發佈流程 & 版型大更新」功能大家使用了嗎？
新版式整體視覺上「更加凸顯圖片」，為了搭配這次的更新，我們推出首次貼文策展 ❤️
使用貼文功能並完成這次的指定任務，還有機會獲得富士即可拍，讓你的美好回憶都可以用即可拍珍藏！
紀錄一下Laravel好用的validator。
E
本筆記參考:
1. https://stackoverflow.com/questions/31539727/laravel-password-validation-rule
續上篇，把程式碼改成這樣，model加上關聯，就可以從article去query comments了。
L27表示從article table中primary key = 1的文章去找所有留言。
L27的$articles變數output如下:
L12這個method: comments()，
假如開發了一個部落格，以下是ERD設計:
接著從程式碼來看如何join:
$this->article
->join('comments', 'article.article_id', '=', 'comments.article_id')
->select('article.article_i
在開發過程中，難免會需要自己寫一些common function，例如Laravel 如何寫 Log這篇提到的，write log為了能夠顯示file name跟line，可以把它封裝成一個common function，以後要改log format也只需要從這邊改...
Laravel的日誌系統底層是Monolog，設定在config\logging.php裡面，預設路徑是在storage\logs\laravel.log，也可以更改成喜歡的路徑。
...
Laravel本身是MVC架構的Framework，但隨著專案越來越龐大，若不把系統架構分工再切細一點，可能會導致日後維護的困難。
例如可能會很常發生controller要與model溝通拿資料，又要處理商業邏輯，就會導致controller越來越肥，因此本文要介紹的是....
本筆記遵循官方文件教學，經過一些小修改，經測試可以跑在Laravel Framework version: 8.13.0，將筆記記錄下來。
......
本文模擬user註冊的情境來簡單演示，在Laravel中如何透過ajax來存取資料，以post request為例。
前端透過post把user資料送到controller中，並且透過model把資料塞進DB，最後回傳json response。
完整source cod
Laravel Framework version: 8.12.3
本範例做了兩個，一個是進到首頁顯示hello world!，另一個是進到article頁面時，從資料庫把文章抓出來顯示。
...