java - 为通过 Google Cloud Endpoints 公开的 API 方法提供文档

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

如何记录每个云端点 API?例如我有以下代码。我可以使用 @Api 注释为 FooApi 编写概述。但是我想在这里为 getSomething 方法写一个文档。有注释吗?

@Api(name = "foo", version = "v1", description = "this api...")
public class FooApi {
  // I want to write a description for this specific method
  @ApiMethod(httpMethod = "get")
  public Bar getSomething() {
  }
}

最佳答案

根据Javadoc for @ApiMethod annotationsEndpoints Annotations文章中,还没有为 @ApiMethod 实现属性来显示为 description,就像 @Api 注释的那样。作为引用,支持的 @Api 注释属性也可以在相同的 Endpoints Annotations 中找到。文章和@Api annotation Javadoc .

关于java - 为通过 Google Cloud Endpoints 公开的 API 方法提供文档,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/34964950/

相关文章:

java - 从 byte[] 类型的像素构建缩小的 ImageIcon 最有效的方法是什么?

java - 使用 Ivy 和私有(private)公司存储库时,我应该把我的凭据放在哪里?

Java: SQLSyntaxErrorException 在 ?象征

python - 请求 https ://www. googleapis.com/bigquery/v2/projects/publicdata/queries?alt=json 时出现 HttpError 403 返回“访问被拒绝:作业 publicdata:

python - Google App Engine - Python - 任务队列 - 如何添加任务列表?

java - 如何处理 Google Cloud Endpoints 和 Java 上的字段值约束?

java - 云端点不尊重 Jackson 注释

java - 类文件编辑器未找到冗余源

Java GAE 后端在 3 分钟内重新启动错误 202

android - 类文件是 Java 8,但在将 GCE 后端部署到 android studio 中的服务器时,最大支持的是 Java 7