是否可以在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."
          }