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生成接口文档还是很有用的,生成的接口代码不推荐直接使用(但可以生成作参考)。

最后编辑于 :
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 137,266评论 19赞 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 47,408评论 6赞 342
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 180,666评论 25赞 708
  • 还记得兄长那时候说这句话气候的悲凉,虽然原话是这样:“今天无论你是多么的伤心,第二天早上还是要爬起来去上班,这个城...
    紫色娇蓝阅读 690评论 0赞 0
  • 王者仗剑走天涯 七彩霞冠昭天下 玉树芝兰见卓识 江山娇美绝风华 自古风流好戎马 踏破狼烟谁人斜(xia) 峥嵘岁月...
    桂花上酸菜阅读 281评论 12赞 15

友情链接更多精彩内容