V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
wencan
V2EX  ›  淘宝

正在欣赏福报厂的 api 文档,什么水平才能写出这样的文档啊

  •  1
     
  •   wencan · 6 天前 · 2433 次点击

    rt
    完全不是写给人看的 看了几个小时,我还不知道从哪里开始,我需要的功能应该调哪几个 api
    每个 api 都没解释清楚,比如下面是一个字段的介绍:

    feature 参数格式
    范例: identCode=tid1:识别码 1,识别码 2|tid2:识别码 3;machineCode=tid3:3C 机器号 A,3C 机器号 B
    identCode 为识别码的 KEY,machineCode 为 3C 的 KEY,多个 key 之间用”;”分隔
    “tid1:识别码 1,识别码 2|tid2:识别码 3”为 identCode 对应的 value 。"|"不同商品间的分隔符。
    例 1 商品和 2 商品,之间就用"|"分开。
    TID 就是商品代表的子订单号,对应 taobao.trade.fullinfo.get 接口获得的 oid 字段。(通过 OID 可以唯一定位到当前商品上)
    ":"TID 和具体传入参数间的分隔符。冒号前表示 TID,之后代表该商品的参数属性。
    "," 属性间分隔符。(对应商品数量,当存在一个商品的数量超过 1 个时,用逗号分开)。
    具体:当订单中 A 商品的数量为 2 个,其中手机串号分别为"12345","67890"。
    参数格式:identCode=TIDA:12345,67890 。TIDA 对应了 A 宝贝,冒号后用逗号分隔的"12345","67890".说明本订单 A 宝贝的数量为 2 ,值分别为"12345","67890"。
    当存在"|"时,就说明订单中存在多个商品,商品间用"|"分隔了开来。|"之后的内容含义同上。
    

    奇怪淘宝的代码是怎么跑起来的?

    几年前曾经对接福报厂 ding 的 api ,和同事嘲笑了 ding 的技术实力好久。后面网上一查,ding 的实力居然还是厂内实力比较强的。现在看来,强了不止一点半点啊

    10 条回复    2025-01-02 09:49:40 +08:00
    bxb100
        1
    bxb100  
       6 天前 via Android   ❤️ 1
    一般都是外包写的…
    TyCoding
        2
    TyCoding  
       6 天前
    基本都是外包写的,甚至大部分产品都是外包写的
    potatowish
        3
    potatowish  
       6 天前 via iPhone
    奇怪难道别家文档不是外包写吗,国内腾讯的文档相对来说挺清晰的
    laikick
        4
    laikick  
       6 天前
    @potatowish 腾讯的文档还清晰? 老中公司的文档都藏着捏着.
    wencan
        5
    wencan  
    OP
       5 天前
    @laikick 哪家文档没毛病?相对来说,腾讯的文档还算清晰,毕竟那么多开发者接入
    福报厂的文档,明显已经不是毛病不毛病,清晰不清晰的问题了
    laikick
        6
    laikick  
       5 天前
    @wencan 国外的公司就开放清晰. 都不用注册随便看 老中的看个文档都恨不得要你实名制
    luckyrayyy
        7
    luckyrayyy  
       5 天前
    倒排工期没空写,人力不足召唤外包,每年换三波人维护,以上就是大厂常态。
    donaldturinglee
        8
    donaldturinglee  
       5 天前
    有时候根本不知道该怎么调接口和传参数. 写的 UML 也是云里雾里
    yikyo
        9
    yikyo  
       5 天前 via iPhone
    没几个平台 API 写的不错,没记错的话微信支付有个大小写参数的问题,第一次对接很容易掉坑,网易 im ,风格不统一,有直接返回的,有回调返回的,没有固定参数格式,很明显是好几波人维护后的结果
    wceozl
        10
    wceozl  
       5 天前
    有幸做过钉钉小程序,api 全靠微信小程序文档和自己猜
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   5555 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 25ms · UTC 09:22 · PVG 17:22 · LAX 01:22 · JFK 04:22
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.