添加描述到谷歌云端点变量

Question

我如何添加一个描述字符串到谷歌云端点变量，使其在谷歌的API浏览器可见?我能够使用注释"" ""向方法添加描述。例如:

@endpoints.method(LocationRequestMessage, LocationResponseMessage, path='location', http_method='POST',
                  name='location.create')
def location_create(self, request):
    """
    Creates a location
    """

下面是我想要实现的一个例子:https://developers.google.com/apis-explorer/p/日历/v3/calendar.acl.insert

输入字段:

calendarId--> 日历标识符.

请求主体:

范围——> 的范围规则

我必须在哪里添加粗体描述文本才能显示它?

Answer 1

注释在发现文件(APPLICATION-NAME-rest.discovery)中定义。

来自Google api Discovery Service:

"methods": {
    (key): {
      "id": string,
      "path": string,
      "httpMethod": string,
      "description": string,
      "parameters": {
        (key): {
          "id": string,
          "type": string,
          "$ref": string,
          "description": string,
          "default": string,
          "required": boolean,
          "format": string,
          "pattern": string,

可以看到有"description"字段。目前，endpoints.sh get-discovery似乎没有获取代码注释并填充这些描述。但是您可以自己修改.discovery文件并将其部署到appengine。