如何向Cloud Endpoint方法添加描述?

时间:2013-08-05 13:50:27

标签: google-app-engine google-cloud-endpoints

如何向Cloud Endpoint方法添加说明?

通过观察,我发现API浏览器使用docstring方法进行描述。

enter image description here

在某些情况下,我们使用装饰器来阻止从API资源管理器中正确解析doscring beeing。

代码示例:

@endpoints.method(ScoreRequestMessage, ScoreResponseMessage,
                  path='scores', http_method='POST',
                  name='scores.insert')
@do_some_checks
def scores_insert(self, request):
    """
    Exposes an API endpoint to insert a score for the current user.

    """
    entity = Score.put_from_message(request)
    return entity.to_message()              

有没有办法为API资源管理器提供端点方法描述?

1 个答案:

答案 0 :(得分:2)

如果您的问题是在应用装饰器后文档字符串丢失,您应该在装饰器中使用装饰器functools.wraps。这样,您将保留函数名称和文档字符串。