【问题标题】:Design REST-api for posts with microservices为带有微服务的帖子设计 REST-api
【发布时间】:2019-04-09 18:36:54
【问题描述】:

我有一个关于我的 rest-api 帖子的“琐碎”问题,但我更喜欢从一开始就让我的设计正确。
帖子可由用户或 google_place_id 请求。
如果没有微服务架构,我会选择这样设计我的 REST-api:

base_uri/gplaces/:gplaceId/posts
base_uri/users/:userId/posts

在使用微服务时,拥有微服务“用户”、“帖子”和“gplaces”对我来说更有意义。

在这种情况下,我的端点将如下所示:

base_uri/posts/gplaces/:gplaceId
base_uri/posts/users/:userId

这对我来说真的没有意义,或者:

base_uri/posts?type=by_place&gplace_id=?
base_uri/posts?type=by_user&user_id=?

我最好使用第一个选项(变体 gplaces/:gplaceId/posts)。

是否反对使用另一个域作为微服务架构中的第一个路径段? (通常 base_uri/gplaces 属于 gplace-api)。

【问题讨论】:

  • 在 REST 架构模型中,URI 的设计充其量是次要的,因为 URI 作为一个整体只是调用更多资源的指针。客户或开发人员不应解释此类 URI,而应依赖此类 URI 附带的有意义的链接关系名称。这允许服务器在不破坏客户端的情况下更改其内部结构。因此,您如何设计 URI 取决于您自己,因此 IMO 高度评价。

标签: rest microservices


【解决方案1】:

如果每个微服务都是一个独立的服务,用户、帖子、地点各有一个,那么我认为网址应该是:

放置微服务:

base_uri/:gplaceId

用户微服务:

base_uri/:userId

发布微服务:

base_uri/user/:userId
base_uri/place/:gplaceId

考虑:

?type=by_user&user_id=? 

type 是多余的,因为您通过第二个参数 user_id 或 gplace_id 来识别类型。我只是认为在 uri 中编码您需要的内容更简洁

每个微服务都有一个隐式契约。返回用户、地点或帖子,因此 url 中超出获取该信息所需的任何内容都无关紧要。

【讨论】:

    猜你喜欢
    • 2022-06-28
    • 2017-12-13
    • 2019-09-09
    • 2018-02-24
    • 2019-10-27
    • 1970-01-01
    • 2019-07-03
    • 2017-03-19
    • 2019-05-21
    相关资源
    最近更新 更多