Q
程序报告里的接口清单怎么排才方便下游直接对接？
A
按调用频次从高到低排，每条接口顶格写路径，下面缩进两格写请求方法、必填参数、返回成功结构体字段名。失败返回只写HTTP状态码+一句话原因，不写错误码表。字段名用代码里真实变量名，不翻译成中文。参数类型写string/int/bool，不写“字符串类型”。
高分写作经验
热门篇幅区间
推荐写法
数据显示，有38.8%的用户认为，首选的写法是字段名严格同步代码，43.2%%的用户倾向选择3500-4500字，而30.4%%的用户选择2800-3400字，18.8%%选择4600-5200字。新手最容易踩的坑是接口按字母顺序排，参数写“用户信息对象”，返回示例用虚构JSON，字段名和代码里对不上。
适用对象
联调中的前端、做自动化测试的QA、接API的第三方、写SDK的同事
新手常犯的误区
接口按字母顺序排，参数写“用户信息对象”，返回示例用虚构JSON，字段名和代码里对不上。
