如何写好接口文档?

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