swagger 初体验

官网：https://swagger.io/

1、swagger是什么？

根据一套数据结构（json或者yaml），可动态生成接口文档，同时还可生成前后端针对 不同语言接口代码的一个平台或者编辑器（node环境本地可以用）。

2、好处。

可以快速的生成清晰的接口文档，提高前后端对接的开发效率。

3、不太好的地方。

• 如果直接编辑json 或者 yaml ，会感觉有点乱或者麻烦，尤其后面接口多起来的话。

pic01.png

• 生成的接口代码（仅以angular2 为例）直接调用是可以用的，但根据数据生成的动态代码会给调用的地方带来不可预知的问题。（假如接口有的地方需要特别修改或者设置的话，会更麻烦）

• 接口文档UI结构不好，如果接口多了不方便查看。

W1BWJWW5P}H5L$5YAIV45UL.png

（如果要查看一个接口详情，得一个劲的整体往上翻。对比下面左右结构的）

OD3{RA4PX4ND3%{LLUY88F3.png

4、结论。

用swagger生成接口文档还是很有用的，生成的接口代码不推荐直接使用（但可以生成作参考）。