google-app-engine - 是否可以向 API Explorer 中的 Cloud Endpoint 字段添加描述？

Question

我已经在 Google API 中看到了这一点。 Cloud Endpoints 也可以吗？



https://developers.google.com/apis-explorer/#p/adexchangebuyer/v1.2/adexchangebuyer.accounts.get

Answer 1

这是完全可能的。我们有一些关于猴子补丁的 StackOverflow 帖子，这将是另一个很好的例子。

例如:
How do I specify my own icons so they show up in a Google Endpoints API discovery document?

对于这种情况，在 /_ah/spi/BackendService.getApiConfigs 提供的内容包含您的 API 配置，您在此处需要的“描述”用于“参数”。

所以例如在方法中

@endpoints.method(MySchema, MySchema,
                  path='myschema/{strField}', name='myschema.echo')
def MySchemaEcho(self, request):
  return request

领域 strField是一个路径“参数”，所以在 API 配置中我们会看到

{
  ...
  "methods": {
    "myapi.myschema.echo": {
      ...
      "request": {
        ...
        "parameters": {
          "strField": {
            "required": true,
            "type": "string"
          }
        }
      },
      ...
    }
    ...
  }
}

要在那里获得您的描述，您需要将其添加到 strField 下列出的字典中。所以它读

          "strField": {
            "required": true,
            "type": "string",
            "description": "Most important field that ever was."
          }