ASP.NET Core 5 EP 6:使用Swagger公開Restful API規格
Swagger的用途
Swagger對後端工程師而言真的是一大救星,通常使用Postman測試API已經是一件非常方便且便利的事情,但其實更多時候,我們不需要這麼Detail的資訊,只是想測試寫完的API到底能不能執行,另一方面,Swagger更是一個與前端(Web or Mobile App)工程師溝通的好工具,直接請他們利用Swagger所付的描述,了解API的規格。
官方網站:https://swagger.io/
安裝Swagger
在這裡要歡呼一下,在建立專案之初,微軟就已經將Swagger放入Web API專案的範本中,所以不需要任何安裝,只要建立專案就自帶Swaager了!
瀏覽Swagger網頁
預設的設定中,只要用瀏覽器連到https://{ip}:{port}/swagger/即可,若沒有特別的設定,可以參考以下網址:
https://localhost:5001/swagger/
就會看到以下畫面:
提醒
Swagger不是Open API的介面,千萬不要透過Swagger公開你的API,這將導致API的資訊外洩,無所遁形之下,很快就會被駭客攻陷的!
還是要再強烈提醒:Swagger不是公開API的工具!
~ END ~