lex

如何使用Swagger编写API文档

helight | 1400字 | 阅读大约需要3分钟 | 归档于linux 应用

2018年1月19日

    最近在梳理内部系统的架构设计,而且前端时间也在kindle上看了一些国外开发在API的架构设计上的一些思考。所以就想着我们内部系统的api也应该梳理梳理了。     目前内部使用golang开发是重头,基本上的服务和调度都是使用golang来开发,而且内部模块之间的调用都是http的接口。而且目前golang1.8已经默认支持了http2的协议,在效率上以前顾虑的问题,现在都有所缓解,所以把这块的梳理重点放在了http接口的梳理上。

    重点看了soap,json-rpc,restfull。在梳理中发现一个比较有意思的东东,叫 Swagger,中文名字也比较有意思:丝袜哥,哈哈。这个东西是做什么的呢:专门用户规范设计API的,简单用了一下还是非常好用的。在其官网这样介绍的:

继续阅读