picasso250
V2EX  ›  PHP

api的调用方式,key是否明示?

  •  
  •   picasso250 · Jan 23, 2014 · 3875 views
    This topic created in 4526 days ago, the information mentioned may be changed or developed.


    这两种api设计方式,你喜欢那种?

    那种是“正确”的?
    10 replies    1970-01-01 08:00:00 +08:00
    family
        1
    family  
       Jan 23, 2014
    没有“正确”✅吧
    “友好”就行
    dialox
        2
    dialox  
       Jan 23, 2014
    从可读性上看,方法1比较好,可以用“key”来描述参数的含义。另外,方法1也方便未来在接口调用的时候增加参数。
    sarices
        3
    sarices  
       Jan 23, 2014
    可以这样,默认value2参数为空,然后必须填写第一个参数,如果第一个参数为数组即表示使用数组传参数
    akira
        4
    akira  
       Jan 23, 2014
    参数数量多,用第一种;参数数量少,用第二种。例如只有一个参数,写key什么的就很多余了。

    PS : 两种格式同时支持又不是不行。。。
    alex321
        5
    alex321  
       Jan 23, 2014
    方法 1 是传递的数组,扩展性很好。
    is_array($temp)///////
    judasnow
        6
    judasnow  
       Jan 23, 2014
    倾向于第一种,便于参数合法性的检查。
    issac
        7
    issac  
       Jan 23, 2014
    第一种清晰,容易理解;
    其实用JSON更方便;
    dorentus
        8
    dorentus  
       Jan 23, 2014 via iPhone
    没有实际场景,没法说哪种是「正确」的。

    如果你不确定的话,可以自己作为自己的用户,做个小项目实际使用一下自己提供的 API 看看感受。
    picasso250
        9
    picasso250  
    OP
       Jan 23, 2014
    @family
    @dialox
    @sarices
    @akira
    @alex321
    @judasnow
    @issac
    @dorentus
    谢谢大家,我心里好受多了。
    otakustay
        10
    otakustay  
       Jan 23, 2014   ❤️ 2
    个人习惯是,设计一个API,其参数分为2类。

    第1类是没它不可的,这一类就直接传递,不放在array中
    第2类是可有可无的,属配置项,放在array中

    举个例子(javascript):

    findUserById(id, { includeDisabledUsers: true })

    这个方法既然叫ById了,id显然是要提供的,因此id显式传递,后面的includeDisabledUsers是有默认值(false)的,不传也没问题,因此放在一个对象中作为配置项。
    这样的好处是你不会少传了什么导致API不能调用,又保留了可扩展性,需要额外的配置项可以在对象里加
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   3021 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 63ms · UTC 14:59 · PVG 22:59 · LAX 07:59 · JFK 10:59
    ♥ Do have faith in what you're doing.