如何在谷歌云端点v2中验证API密钥

Question

我是谷歌云端点的新手，尤其是V2，我认为它是制作基于服务的应用程序的重要一层。从文档中我观察到，他们提供了使用端点框架的选项，然后当我使用需要api key的框架，然后生成openapi.json时，打开api .Now。当我没有API key的情况下发出请求时，.i似乎得不到任何错误。我想知道，当我将我的类标记为API key required .Am I来自己提供验证逻辑时，为什么会这样？这是用api验证所有方法的配置。

@Api(name = "testapi",
    version = "v1",
    apiKeyRequired = AnnotationBoolean.TRUE,
    scopes = {Constants.EMAIL_SCOPE},
    clientIds = {Constants.WEB_CLIENT_ID, Constants.ANDROID_CLIENT_ID},
    audiences = {Constants.ANDROID_AUDIENCE}

)

然后，为了生成openapi.json文件，这是pom配置，尽管我仍然在努力掌握如何以这种方式配置它，我不需要输入我的服务类

 <profiles>
    <profile>
        <id>GetSwaggerDoc</id>
        <activation>
            <property>
                <name>GetSwaggerDoc</name>
            </property>
        </activation>
        <build>
            <plugins>
                <plugin>
                    <groupId>org.codehaus.mojo</groupId>
                    <artifactId>exec-maven-plugin</artifactId>
                    <version>1.4.0</version>
                    <configuration>
                        <includePluginDependencies>true</includePluginDependencies>
                        <mainClass>com.google.api.server.spi.tools.EndpointsTool</mainClass>
                        <arguments>
                            <argument>get-swagger-doc</argument>
                            <argument>--hostname=test-api.endpoints.${endpoints.project.id}.cloud.goog</argument>
                            <argument>--war=target/test-1.0-SNAPSHOT</argument>
                            <argument>com.rareatom.test.services.TestApi</argument>
                        </arguments>
                    </configuration>
                    <dependencies>
                        <dependency>
                            <groupId>com.google.endpoints</groupId>
                            <artifactId>endpoints-framework-tools</artifactId>
                            <version>${endpoints.framework.version}</version>
                        </dependency>
                        <dependency>
                            <groupId>com.google.appengine</groupId>
                            <artifactId>appengine-api-1.0-sdk</artifactId>
                            <version>1.9.30</version>
                        </dependency>
                    </dependencies>
                </plugin>
            </plugins>
        </build>
    </profile>
</profiles>`

当我运行mvn exec:java -DGetSwaggerDoc时，会生成以下代码

​

{
 "swagger": "2.0",
 "info": {
  "version": "1.0.0",
  "title": "test-api.endpoints.test-test-160113.cloud.goog"
 },
 "host": "test-api.endpoints.test-test-160113.cloud.goog",
 "basePath": "/_ah/api",
 "schemes": [
  "https"
 ],
 "consumes": [
  "application/json"
 ],
 "produces": [
  "application/json"
 ],
 "paths": {
  "/testapi/v1/test": {
   "post": {
    "operationId": "TestapiTest",
    "parameters": [ ],
    "responses": {
     "200": {
      "description": "A successful response",
      "schema": {
       "$ref": "#/definitions/Response"
      }
     }
    },
    "security": [
     {
      "google_id_token": [ ]
     },
     {
      "google_id_token_https": [ ]
     },
     {
      "api_key": [ ]
     }
    ],
    "x-security": [
     {
      "google_id_token": {
       "audiences": [
        "AIzaSyAsnv2yeF6003txjfBVrZrlUe8jvfUJAtE"
       ]
      }
     },
     {
      "google_id_token_https": {
       "audiences": [
        "AIzaSyAsnv2yeF6003txjfBVrZrlUe8jvfUJAtE"
       ]
      }
     }
    ]
   }
  }
 },
 "securityDefinitions": {
  "google_id_token_https": {
   "type": "oauth2",
   "authorizationUrl": "",
   "flow": "implicit",
   "x-google-issuer": "https://accounts.google.com",
   "x-google-jwks_uri": "https://www.googleapis.com/oauth2/v1/certs"
  },
  "api_key": {
   "type": "apiKey",
   "name": "key",
   "in": "query"
  },
  "google_id_token": {
   "type": "oauth2",
   "authorizationUrl": "",
   "flow": "implicit",
   "x-google-issuer": "accounts.google.com",
   "x-google-jwks_uri": "https://www.googleapis.com/oauth2/v1/certs"
  }
 },
 "definitions": {
  "Status": {
   "enum": [
    "SUCCESS",
    "FAILURE"
   ]
  },
  "Response": {
   "properties": {
    "code": {
     "type": "integer",
     "format": "int32"
    },
    "data": {
     "$ref": "#/definitions/_any"
    },
    "message": {
     "type": "string"
    },
    "status": {
     "$ref": "#/definitions/Status"
    }
   }
  },
  "_any": { }
 }
}

​

然后使用gcloud service-management deploy部署此配置。

Answer 1

我注意到，当您的pom.xml和web.xml中有多个参数或多个带@Api注释的类时，就会验证API键

pom.xml

<arguments>
  <argument>get-swagger-doc</argument>
  <argument>--hostname=tita-api.endpoints.${endpoints.project.id}.cloud.goog</argument>
   <argument>--war=target/tita-1.0-SNAPSHOT</argument>           
   <argument>com.rareatom.tita.services.TestApi</argument>                               
   <argument>com.rareatom.tita.services.SessionServices</argument>                     
                        </arguments>

对于你的web.xml

<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.rareatom.tita.services.TestApi,
        com.rareatom.tita.services.SessionServices</param-value>
</init-param>
</servlet>