swagger 初始使用

swagger ，這個東西也是在項目中用到的，一個很實用的API 學習工具。

Swagger包括庫、編輯器、代碼生成器等很多部分，這裏我們主要講一下Swagger Editor。

swagger editor 在 http://editor.swagger.io/ 這個在線版本的的編輯生成工具，該工具左側編輯API文檔，右側自動生成有咩的API接口，左側包括API名字，描述，使用形式，paramers、 responses 都可以編輯，並在右側自動生成API接口函數。如下圖：

編輯成功後可保存爲 xxx.yaml 文件。

通過此編輯器，可以打開已經遍及好的yaml文件，並點擊對應API的 Try it Out 按鈕即可執行該API進行調試。

該工具調試過程是通過 curl 工具來發送命令的，該工具會自動封裝成如下格式的命令：
curl -X POST “https://petstore.swagger.io/v2/pet” -H “accept: /” -H “Content-Type: application/json” -d “{“id”:0,“category”:{“id”:0,“name”:“string”},“name”:“doggie”,“photoUrls”:[“string”],“tags”:[{“id”:0,“name”:“string”}],“status”:“available”}”

yaml文件中有對服務器地址的設置，如圖：

除了測試私有API接口這個實用功能外，此編輯器還可以生成不同語言的server端 和 client 端。可以省區好多些函數接口的時間，將生成的文件直接引用就好。