1 HTTP携带信息的方式 url headers body: 包括请求体，响应体 2 分离通用信息 一般来说，headers里的信息都是通用的，可以提前说明，作为默认参数 3 路径中的参数表达式 URL中参数表达式使用mustache的形式，参数包裹在双大括号之中{{paramName}} 例如： /api/user/{{userId}} /api/user/{{userType}}?age={{age}}&g...

本文来自于公司内部的一个分享。在文档方面，对内的一些接口文档主要是用swagger来写的。虽然可以在线测试，比较方便。但是也存在着一些更新不及时，swgger文档无法导出成文件的问题。在对外提供的文档方面：我主要负责做一个浏览器端的一个js sdk。文档还算可以github地址，所以想把一些写文档的心得分享给大家。