[.Net] 一個方便產生 swagger 離線文件的好網站

2022-02-17

今天介紹一個 好用的網站,有時候 web api 寫好了,需要先把文件分享出去但是實際上這份文件只是先給對方預覽

你也還沒有再對外公開機器上面,雖然你說架好 swagger 就可以了,但是就是還沒對外,或是你只是要敘述你系統要怎麼呼叫

不可能因為他架設一個 sample 網站,今天找到一個不錯的 網站 https://editor.swagger.io/



1.首先,當然你要會將你的  web api 放入 swagger 方法請參考 

https://docs.microsoft.com/zh-tw/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-6.0&tabs=visual-studio

 
2.架設起來後你在這裡可以找到 swagger.json 內容大概如下,把這內容複製起來




3. 之後到 https://editor.swagger.io/ 這網站,貼上swagger.json 的內容

範例內容:

4. 選取 Generate List 中的 html2 就可以得到一包 zip ,你就可以打開,看到一份簡單的文件,當然沒有 server 不能測試

但是基本上就可以看出怎麼呼叫,而且還有個語言的範例程式碼




5. 當然功能不只這個,他還可以產生 C# 的呼叫範例程式,我覺得很方便推薦給大家。


當麻許的超技八 2014 | Donma Hsu Design.