具有多个服务类的云端点

Question

我开始使用 Google Cloud Endpoints，但在指定多个服务类时遇到了问题。知道如何让它工作吗？

ApiConfigurationError: Attempting to implement service myservice, version v1, with multiple classes that aren't compatible. See docstring for api() for examples how to implement a multi-class API.

这就是我创建端点服务器的方式。

AVAILABLE_SERVICES = [
  FirstService,
  SecondService
]

app = endpoints.api_server(AVAILABLE_SERVICES)

对于每个服务类我都这样做：

@endpoints.api(name='myservice', version='v1', description='MyService API')
class FirstService(remote.Service):
...

@endpoints.api(name='myservice', version='v1', description='MyService API')
class SecondService(remote.Service):
...

这些中的每一个都可以完美地单独工作，但我不确定在组合它们时如何让它们工作。

非常感谢。

Answer 1

正确的方法是创建一个api对象并使用collection

api_root = endpoints.api(name='myservice', version='v1', description='MyService API')

@api_root.collection(resource_name='first')
class FirstService(remote.Service):
  ...


@api_root.collection(resource_name='second')
class SecondService(remote.Service):
  ...

资源名称将被插入到方法名称的前面，以便您可以使用

  @endpoints.method(name='method', ...)
  def MyMethod(self, request):
    ...

而不是

  @endpoints.method(name='first.method', ...)
  def MyMethod(self, request):
    ...

将其放入 API 服务器：

api_root 对象等价于用endpoints.api 修饰的remote.Service 类，因此您可以简单地将其包含在endpoints.api_server 列表中。例如：

application = endpoints.api_server([api_root, ...])

Answer 2

如果我没记错的话，您应该为每个服务指定不同的名称，这样您就可以同时访问这两个服务，每个服务都有特定的“地址”。

@endpoints.api(name='myservice_one', version='v1', description='MyService One API')
class FirstService(remote.Service):
...

@endpoints.api(name='myservice_two', version='v1', description='MyService Two API')
class SecondService(remote.Service):
...

Answer 3

我已成功部署在两个类中实现的单个 api。您可以尝试使用以下 sn-p（几乎直接来自 google documentation）：

an_api = endpoints.api(name='library', version='v1.0')

@an_api.api_class(resource_name='shelves')
class Shelves(remote.Service):
...

@an_api.api_class(resource_name='books', path='books')
class Books(remote.Service):
...

APPLICATION = endpoints.api_server([an_api],
                               restricted=False)

Answer 4

对于本地开发，我使用了一种临时解决方法，即禁用异常（我知道我知道...）

在我的 sdk 中 google_appengine/google/appengine/ext/endpoints/api_backend_service.py 第 97 行附近：

        elif service_class != method_class:
          pass
#          raise api_config.ApiConfigurationError(
#              'SPI registered with multiple classes within one '
#              'configuration (%s and %s).  Each call to register_spi should '
#              'only contain the methods from a single class.  Call '
#              'repeatedly for multiple classes.' % (service_class,
#                                                    method_class))
    if service_class is not None:

结合我正在使用的构造：

application = endpoints.api_server([FirstService, SecondService, ...])

同样，这在生产中不起作用，在那里你会得到同样的异常。希望这个答案会被未来的修复所淘汰。

确认它现在已过时（针对 1.8.2 进行测试）。

Answer 5

如果是 Java ...

https://developers.google.com/appengine/docs/java/endpoints/multiclass

云并不容易。