【问题标题】:How do I name my APIs in API store (WSO2)? Is there any naming conventions or best practices?如何在 API 商店 (WSO2) 中命名我的 API?是否有任何命名约定或最佳实践?
【发布时间】:2020-04-10 11:24:54
【问题描述】:

我正在尝试创建和发布来自不同服务提供商的 API,并将它们作为通用解决方案发布(在单个 API 商店下)。目前,我正在尝试使 API 名称像 action(verb)-onwhat(noun) 一样简单且具有描述性。例如,我有一个获取 FOO 列表的 API,我将该 API 命名为 List-FOO。这么简单对吧?

但真正的问题出现在这里。正如我所说的那样,我正在为多个服务提供商做这件事,我很可能有 API 来列出另一个服务提供商的特定 FOO。甚至我认为 service_provider-action(verb)-onwhat(noun) 就像 ProviderA-List-FOO。

但我认为如果我希望商店成为普通商店,那将没有任何意义。有什么我遗漏的,还是有更好的方法来命名存储中的 API 以避免此类问题?任何帮助都是非常可观的。

【问题讨论】:

    标签: api wso2 naming-conventions wso2-am


    【解决方案1】:

    根据给定的要求,我建议您为每个服务提供商定义单独的 API 包。例如,您可以为 ProviderA 创建新的 API,并将 ProviderA 的所有服务定义为该 API 下的 资源路径。

    【讨论】:

    • 感谢您的建议。但即使这样我也做不到,因为我需要将每个服务公开为 API,而不是将服务提供者公开为 API。因为供应商不需要订阅服务提供商,而只需订阅服务。
    • 您能详细说明一下服务和服务提供商吗?例如,服务:[List-Foo,Create-Foo,Update-Foo,Delete-Foo],服务提供者:[ProviderA,ProviderB],所以所有服务提供者都暴露了所有服务?
    猜你喜欢
    • 1970-01-01
    • 2011-01-16
    • 1970-01-01
    • 2010-10-21
    • 2011-04-26
    • 2010-11-17
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多