Question

我有一个配置了Cloud Endpoints Framework的Java 8项目。

我在这里关注了文档：https://cloud.google.com/endpoints/docs/frameworks/java/get-started-frameworks-java

我尝试使用API密钥保护API。我在这里关注了文档：https://cloud.google.com/endpoints/docs/frameworks/java/restricting-api-access-with-api-keys-frameworks

问题在于，无论是否设置API密钥，我都可以始终访问端点。

这是API：

@Api(
        name = "myApi",
        title = "My API",
        version = "v1",
        description = "My API description",
        apiKeyRequired = AnnotationBoolean.TRUE
)
public class MyApiEndpoint {
    @ApiMethod(httpMethod = GET, path = "list", apiKeyRequired = AnnotationBoolean.TRUE)
    public ApiEntityList list() throws Exception {
        return new ApiEntityList();
    }
}

这是web.xml：

<?xml version="1.0" encoding="utf-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
         http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd" version="3.1">
<filter>
    <filter-name>endpoints-api-controller</filter-name>
    <filter-class>com.google.api.control.extensions.appengine.GoogleAppEngineControlFilter</filter-class>
    <init-param>
        <param-name>endpoints.projectId</param-name>
        <param-value>${app.deploy.project}</param-value>
    </init-param>
    <init-param>
        <param-name>endpoints.serviceName</param-name>
        <param-value>${app.deploy.project}.appspot.com</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>endpoints-api-controller</filter-name>
    <servlet-name>EndpointsServlet</servlet-name>
</filter-mapping>

<filter>
    <filter-name>endpoints-api-configuration</filter-name>
    <filter-class>com.google.api.control.ServiceManagementConfigFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>endpoints-api-configuration</filter-name>
    <servlet-name>EndpointsServlet</servlet-name>
</filter-mapping>

<servlet>
    <servlet-name>EndpointsServlet</servlet-name>
    <servlet-class>com.google.api.server.spi.EndpointsServlet</servlet-class>
    <init-param>
        <param-name>services</param-name>
        <param-value>com.myproject.MyApiEndpoint</param-value>
    </init-param>
</servlet>
<servlet-mapping>
    <servlet-name>EndpointsServlet</servlet-name>
    <url-pattern>/_ah/api/*</url-pattern>
</servlet-mapping>

appengine-web.xml：

<?xml version="1.0" encoding="utf-8"?>
<appengine-web-app xmlns="http://appengine.google.com/ns/1.0">
    <runtime>java8</runtime>
    <threadsafe>true</threadsafe>
    <service>core</service>
    <url-stream-handler>urlfetch</url-stream-handler>
    <system-properties>
        <property name="java.util.logging.config.file" value="WEB-INF/logging.properties"/>
    </system-properties>
    <env-variables>
        <env-var name="ENDPOINTS_SERVICE_NAME" value="${app.deploy.project}.appspot.com" />
    </env-variables>
</appengine-web-app>

我没有任何限制地将API密钥创建为Google Cloud Platform项目中的新凭据。

我可以在GCP上部署的openapi.json文件中看到以下几行：

  "/myApi/v1/list": {
   "get": {
    "operationId": "MyApiList",
    "parameters": [ ],
    "responses": {
     "200": {
      "description": "A successful response",
      "schema": {
       "$ref": "#/definitions/ApiEntityList"
      }
     }
    },
    "security": [
     {
      "api_key": [ ]
     }
    ]
   }
  },
  "securityDefinitions": {
    "api_key": {
      "type": "apiKey",
      "name": "key",
      "in": "query"
    }
  },

以下所有呼叫都不会被拒绝，但我希望它们是：

https://core-dot-gcp-project.appspot.com/_ah/api/myApi/v1/list
https://core-dot-gcp-project.appspot.com/_ah/api/myApi/v1/list?key=FAKE_API_KEY
从API Explorer调用
甚至来自本地服务器：http://localhost:8080/_ah/api/myApi/v1/list

看来apiKeyRequired注释参数没有任何作用。

我在这里想念什么吗？

Answer 1

我刚刚对其进行了测试，并通过在openapi.json文件中添加了除api注释之外的顶级安全性指令来使其工作。它应该看起来像这样：

{
 "swagger": "2.0",
 "info": {
  "version": "1.0.0",
  "title": "<PROJECT_ID>.appspot.com"
 },
 "host": "<PROJECT_ID>.appspot.com",
 "basePath": "/_ah/api",
 "schemes": [
  "https"
 ],
 "security": [
     {
      "api_key": [ ]
     }
 ],

此后，我在部署$ gcloud endpoints services deploy target/openapi-docs/openapi.json和$ mvn appengine:deploy中运行agia

Answer 2

您确定已启用API吗？我的意思是，当您创建一个Cloud Endpoints Project时，它也会有效地将这些端点声明为“私有API”。然后，您必须启用它才能使API密钥生效

在控制台中，输入“ API和服务”
点击“ +启用API和服务” ||侧面菜单中的“库”
在侧面菜单中单击“私有”以获取私有API
您应该（希望）能够看到通过Cloud Endpoints创建的“ API”

对于某些人来说，它似乎是自动执行的，但似乎有一个合理的数字，它不是自动执行的。我真的不知道为什么。

希望有帮助！

Answer 3

我认为您不是在使用默认的App Engine服务，而是在URL旁使用名为“核心”的服务。

如果这是真的，那么我认为您需要更新以下内容以配置终结点框架以了解要应用于哪个服务：

web.xml：

com.google.api.control.extensions.appengine.GoogleAppEngineControlFilter的过滤器定义中的参数名称 endpoints.serviceName 的参数值，以将服务名称包括在${app.deploy.project}.appspot.com

之前

<filter>
    <filter-name>endpoints-api-controller</filter-name>
    <filter-class>com.google.api.control.extensions.appengine.GoogleAppEngineControlFilter</filter-class>
    <init-param>
        <param-name>endpoints.projectId</param-name>
        <param-value>${app.deploy.project}</param-value>
    </init-param>
    <init-param>
        <param-name>endpoints.serviceName</param-name>
        <param-value>core-dot-${app.deploy.project}.appspot.com</param-value>
    </init-param>
</filter>

appengine.web.xml：

ENDPOINTS_SERVICE_NAME 的环境变量值，以在${app.deploy.project}.appspot.com

之前包含服务名称

<env-variables>
    <env-var name="ENDPOINTS_SERVICE_NAME" value="core-dot-${app.deploy.project}.appspot.com" />
</env-variables>

Answer 4

对于将来查看此问题的任何人.. 我遇到了同样的问题，结果我更改了@ApiMethod 中指定的路径，并且没有将新的 openAPI 文档部署到 Cloud Endpoints。

我已使用 mvn appengine:deploy 将我的项目部署到 App Engine 但我忘记了我还需要按照 Deploying the Endpoints Configuration 上的此文档重新部署我的 openAPI 文档。所以它仍然使用我最初部署的旧资源/路径。当我将我的 openAPI 文档基本路径和 @ApiMethod 注释中的路径修复为我想要的时，我将其部署到 Cloud Endpoints，然后 apiKeyRequired 注释再次起作用！

apiKeyRequired在Google Cloud Endpoints项目中不起作用

4 个答案: