RainyH2O
V2EX  ›  问与答

接口的参数之间的互相依赖要怎么表达在文档里?

  •  
  •   RainyH2O · Jul 25, 2022 · 2103 views
    This topic created in 1410 days ago, the information mentioned may be changed or developed.
    比如一个接口的参数 B 当且仅当参数 A 提供了的时候必须提供,而参数 A 本身是可选参数。
    又比如一个接口的参数 A 、B 必须要提供其中之一或者同时提供,但不能同时省略。
    9 replies    2022-07-25 17:30:13 +08:00
    zhazi
        1
    zhazi  
       Jul 25, 2022
    文档里?
    文档不是想怎么写怎么写
    你要说接口里可以看下 restful level3
    yunying
        2
    yunying  
       Jul 25, 2022
    感觉应该要合并成一个接口来控制比较妥当。。要不分开了的话。你还是很难保证调用方会不会随心所欲地使用
    wu67
        3
    wu67  
       Jul 25, 2022
    params: { a: { value: balabala, b: 11111 } }.

    params: [a, b, ...]
    kera0a
        4
    kera0a  
       Jul 25, 2022
    重载呗,
    伪代码写一下类似下面这样

    第一种
    func (any? A = a)
    func (any A, any A)

    第二种
    func (any A, any B)
    func (any A)
    func (any B)
    micean
        5
    micean  
       Jul 25, 2022
    文档的话,字段说明里写一下不就行了吗?
    damai0419
        6
    damai0419  
       Jul 25, 2022
    一般写字段备注里。
    1. B:仅当 A 有值时,此字段有值。
    2. A: A 、B 不可同时为空。
    B: A 、B 不可同时为空。
    wolfie
        7
    wolfie  
       Jul 25, 2022
    必填列 写明 二选一 必填。
    Jooooooooo
        8
    Jooooooooo  
       Jul 25, 2022
    加个备注项.
    RainyH2O
        9
    RainyH2O  
    OP
       Jul 25, 2022
    @damai0419 看来是只有备注了。其实像 JSON Schema Validation 有提供 dependentRequired ,但是 OpenAPI Specification 却迟迟没提供类似功能。我想了解下大家平时怎么解决的,唯一的问题是备注这种纯文本没法借助 Validator 工具做自动化结构校验。
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   5743 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 47ms · UTC 03:15 · PVG 11:15 · LAX 20:15 · JFK 23:15
    ♥ Do have faith in what you're doing.