先写接口文档,还是先写代码?

一种方案: 利用swagger套件,设计接口,生成接口文档 swagger生成的go代码不可用,但可以自己实现一套go代码生成器 然后团队照着接口,实现代码 这也是我之前采用的方案 另一种方案: 想好接口大概是什么样子,写代码,根据代码生成接口文档
已邀请:

xkey - go

赞同来自: alphayan

唯一不变的就是变化,随着项目的推进会发现之前的接口设计就完全不合需求,所以那种方案都不是最佳的,第一种会浪费大量的时间,第二种代码写完就不想写文档了。

golang的swagger文档的代码侵入性比较严重,最好还是一个模块写完立即补接口文档,重新确认需求。

个人推荐markdown

kevin - 杭州云柚科技

其实两种可以根据开发模式选择,如果是TDD/BDD,明显要选第一种。
swagger套件,太烦,代码侵入性比较严重,求推荐哪种

chai2010 - 数盲患者

可以尝试用Protobuf定义接口,然后生成代码。
有很多开源的Protobuf插件支持类似功能,比如 [grpc-gateway](https://github.com/grpc-ecosystem/grpc-gateway) 和 [pbgo](https://github.com/chai2010/pbgo) 等。

要回复问题请先登录注册