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 端。可以省区好多些函数接口的时间，将生成的文件直接引用就好。