呜噢哇
← 全部笔记

读文档时先找能跑的例子

2026-06-12

以前读接口文档喜欢从头看到尾,章节标题抄一遍,参数表也划一遍。合上之后还是不会用。后来改成:先在页面里找最小的请求例子,原样跑通,再回头对参数。

好处很具体。例子能跑,说明环境、鉴权、路径至少有一条是对的。后面看可选字段,才知道哪些是自己这次用得上的。对不上的报错,也比「我好像看过这一节」好查。

如果文档里没有例子,就自己写一个只含必填项的。能通了再往上加字段。比空着想象「这个枚举会怎样」省时间。

手册还是要留着,当字典用,不当小说读。