【问题标题】:API Endpoint SemanticsAPI 端点语义
【发布时间】:2011-06-29 09:31:49
【问题描述】:

API 端点是“方法”,例如 https://api.foursquare.com/v2/venues/ 还是包含非查询字符串参数的完整 URL,例如 https://api.foursquare.com/v2/venues/5104

换句话说,这两个独立的端点还是被认为是同一个端点? http://myapi.com/somemodel/1
http://myapi.com/somemodel/2

【问题讨论】:

    标签: api-design


    【解决方案1】:

    根据this Wikipedia article,端点是一个Web服务,由一个WSDL文件定义,并且

    除了定义 网络地址或连接点 服务。它通常表示 通过一个简单的 HTTP URL 字符串。

    Microsoft uses the term endpoint in various contexts,但它们都等同于同一件事:端点是整个接口,不是一个特定的方法。

    REST 端点的上下文中,端点将包含必要的 GET、PUT、POST 和 DELETE 方法(如适用)。

    【讨论】:

    • 那么myapi.com/mymethod/1myapi.com/mymethod/2 是同一个端点吗?
    • 是的,前提是 1 和 2 是您的方法的参数,而不是单独的完整端点接口的地址(可能,但不是我设计的方式)。
    • 实际上基于维基百科的定义,每个 url 都会导致一个服务为 1 和 2 描述的资源提供数据。所以它们是 2 个不同的端点。我认为端点应该只是一个后缀,它们可以共享相同的基本 url。
    • @HukeLau_DABA:看看维基百科文章定义“操作”的方式。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2018-09-14
    • 2018-05-14
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2020-04-14
    • 2021-05-18
    相关资源
    最近更新 更多