我如何在API存储(WSO2)中命名我的API?是否有任何命名约定或最佳做法?

问题描述 投票:0回答:1

我正在尝试创建和发布来自不同服务提供商的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个回答
0
投票

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

© www.soinside.com 2019 - 2024. All rights reserved.