【问题标题】:How can I get restler to accept multiple routes to a method, but only document one of them?我怎样才能让restler接受一个方法的多个路由,但只记录其中一个?
【发布时间】:2015-10-06 18:46:16
【问题描述】:

我正在修复 API,我想弃用一些旧路由。我基本上是在移动端点,但想鼓励新消费者使用新路线。但是,在此过渡期间,我需要在短时间内支持旧路线。下面是我想要的东西的一个例子。我希望记录新的 url,而旧的 url 要么标记为已弃用,要么完全从文档中删除。有没有简单的方法可以做到这一点,还是我在过渡期间卡住了?

/**
 * Adds a new Item
 *
 * This creates a new item
 *
 * @url POST /:id/patch  {@deprecated}
 * @url PATCH /:id 
 */ 

【问题讨论】:

    标签: php restler


    【解决方案1】:

    将不推荐使用的路由移至新方法,该方法在内部调用旧方法以获得功能,如果需要,可借助 HTML 的帮助通过描述将其标记为不推荐使用。这是一个例子

    /**
     * Adds a new Item
     *
     * This creates a new item
     *
     * @url PATCH /{id}
     */
    function patchItem($id)
    {
        //actual process here
    }
    
    
    /**
     * Adds a new Item [DEPRECATED]
     *
     * This creates a new item
     *
     * @url POST /{id}/patch
     */
    function deprecatedPatchItem($id)
    {
        return $this->patchItem($id);
    }
    

    一旦您决定删除已弃用的方法,只需删除新方法

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2015-03-21
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多