API サービスの名前は Google Cloud 上で一意である必要があります。Endpoints ではサービスの識別に DNS と互換性のある名前を使用できるので、サービス名として API のドメイン名やサブドメイン名の使用をおすすめします。これにより、[エンドポイント] の [サービス] ページに表示されるサービス名と API へのリクエストで使用する名前を一致させることができます。また、サービス名とドメイン名が同じ場合は、API ユーザー用の Cloud Endpoints Portal を作成できます。Endpoints には、サービス名に関する以下の要件があります。
Google は cloud.goog ドメインと appspot.com ドメインを所有し、管理しています。Google が管理するドメインを使用する場合は、サービス名の一部として Google Cloud プロジェクト ID を使用する必要があります。Google Cloud プロジェクトにはグローバルに一意のプロジェクト ID が付いているため、この要件によって一意のサービス名を作成できます。
使用するドメイン名は、API をホストするバックエンドによって異なります。
App Engine フレキシブル環境でホストされる API の場合は、appspot.com ドメインを使用する必要があり、サービス名は次の形式となります。YOUR_PROJECT_ID は Google Cloud プロジェクト ID です。
YOUR_PROJECT_ID.appspot.com
App Engine に API をデプロイすると、YOUR_PROJECT_ID.appspot.com 形式の名前の DNS エントリが自動的に作成されます。
Compute Engine、Google Kubernetes Engine、または Kubernetes でホストされている API の場合は cloud.goog ドメイン名を使用する必要があり、サービス名は次の形式となります。YOUR_API_NAMEは API の名前です。
[[["わかりやすい","easyToUnderstand","thumb-up"],["問題の解決に役立った","solvedMyProblem","thumb-up"],["その他","otherUp","thumb-up"]],[["わかりにくい","hardToUnderstand","thumb-down"],["情報またはサンプルコードが不正確","incorrectInformationOrSampleCode","thumb-down"],["必要な情報 / サンプルがない","missingTheInformationSamplesINeed","thumb-down"],["翻訳に関する問題","translationIssue","thumb-down"],["その他","otherDown","thumb-down"]],["最終更新日 2024-12-21 UTC。"],[[["\u003cp\u003eCloud Endpoints supports APIs described using version 2.0 of the OpenAPI specification, allowing configuration of features like authentication and quotas within an OpenAPI document.\u003c/p\u003e\n"],["\u003cp\u003eEndpoints uses specific fields within the OpenAPI document, including \u003ccode\u003ehost\u003c/code\u003e, \u003ccode\u003einfo.title\u003c/code\u003e, \u003ccode\u003einfo.version\u003c/code\u003e, and \u003ccode\u003eoperationId\u003c/code\u003e, for service identification and display within the Google Cloud console.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ehost\u003c/code\u003e field determines the service name, which must be unique on Google Cloud and is recommended to match the API's domain or subdomain name for consistency and potential use with Cloud Endpoints Portal.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003einfo.title\u003c/code\u003e field provides a user-friendly name for the API, displayed in the Endpoints Services page, and \u003ccode\u003einfo.version\u003c/code\u003e specifies the API's version number.\u003c/p\u003e\n"],["\u003cp\u003eAlthough optional in the OpenAPI Specification, \u003ccode\u003eoperationId\u003c/code\u003e is required by Endpoints for internal operation identification, and its value must be unique within the API.\u003c/p\u003e\n"]]],[],null,["# Configuring Cloud Endpoints\n\nOpenAPI \\| [gRPC](/endpoints/docs/grpc/configure-endpoints \"View this page for the Cloud Endpoints gRPC docs\")\n\n\u003cbr /\u003e\n\nCloud Endpoints supports APIs that are described using version 2.0 of\nthe [OpenAPI specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md).\nYou describe the API [surface](/endpoints/docs/openapi/glossary#surface) and\nconfigure Endpoints features such as\n[authentication rules](/endpoints/docs/openapi/authentication-method) or\n[quotas](/endpoints/docs/openapi/quotas-overview) in an\n[OpenAPI document](/endpoints/docs/openapi/glossary#open_api_doc).\n\nEndpoints makes special use of the following required fields in\nyour OpenAPI document:\n\n- `host`\n- `info.title`\n- `info.version`\n- `operationId`\n\nThis page provides information about how Endpoints uses the\npreceding fields. With this information, you can finish preparing your OpenAPI\ndocument for [deployment](/endpoints/docs/openapi/deploy-endpoints-config).\n\nPrerequisites\n-------------\n\nAs a starting point, this page assumes that you have:\n\n- A [Google Cloud project](/resource-manager/docs/creating-managing-projects).\n- Basic knowledge of [OpenAPI](/endpoints/docs/openapi/openapi-overview).\n- An OpenAPI document in the format described in the [Swagger basic structure](https://swagger.io/docs/specification/2-0/basic-structure/) documentation.\n\n`host`\n------\n\nCloud Endpoints uses the name you configure in the `host` field of your OpenAPI document as the name of your service.\n\nThe name of your API service must be unique on Google Cloud. Because\nEndpoints uses DNS-compatible names to identify services, we\nrecommend that you use your API's domain name or subdomain name as the service\nname. With this approach, the service name that appears on the **Endpoints\nServices** page matches the name used in requests to your API.\nEndpoints has the following requirements for the service name:\n\nYou can either register your own custom domain (such as `example.com`), or\nyou can use a domain managed by Google.\n\n### Use a domain managed by Google\n\nGoogle owns and manages the `cloud.goog` and the `appspot.com` domains. If you want to use a domain managed by Google, you must use your Google Cloud project ID as part of the service name. Because Google Cloud projects have a globally unique project ID, this requirement ensures that you have a unique service name.\n\n\u003cbr /\u003e\n\nThe domain name that you use depends on the backend that hosts your API:\n\n- For APIs that are hosted on the App Engine flexible environment, you must\n use the `appspot.com` domain, and the service name must be in the following\n format, where \u003cvar translate=\"no\"\u003eYOUR_PROJECT_ID\u003c/var\u003e is your\n Google Cloud project ID:\n\n ```\n YOUR_PROJECT_ID.appspot.com\n ```\n\n When you deploy your API to App Engine, a DNS entry with a name in\n the format \u003cvar translate=\"no\"\u003eYOUR_PROJECT_ID\u003c/var\u003e`.appspot.com` is created\n automatically.\n- For APIs that are hosted on Compute Engine, Google Kubernetes Engine, or\n Kubernetes, you must use the `cloud.goog` domain, and the service name must\n be in the following format, where \u003cvar translate=\"no\"\u003eYOUR_API_NAME\u003c/var\u003e is\n the name of your API:\n\n ```\n YOUR_API_NAME.endpoints.YOUR_PROJECT_ID.cloud.goog\n ```\n\n To use this domain as the API's domain name, read\n [Configuring DNS on the `cloud.goog` domain](/endpoints/docs/openapi/cloud-goog-dns-configure).\n\n### Use a custom domain\n\nIf you don't want to use a domain managed by Google, you can use a custom domain\n(for example, `myapi.mycompany.com`) that you are authorized to use.\nBefore you deploy the API configuration, follow the steps in\n[Verify ownership of the domain](/endpoints/docs/openapi/verify-domain-name).\n\n`info.title`\n------------\n\nThe `info.title` field is a user-friendly name for your API. The\n**Endpoints** \\\u003e **Services** page in the Google Cloud console displays the\ntext that you configure in the `info.title` field. If you have more than\none API per Google Cloud project, the API name is displayed in a list when you\nfirst open the page. You can click on the API name to open another page\nthat displays the API's metrics, deployment history, and other information.\n\n`info.version`\n--------------\n\nThe **Endpoints** \\\u003e **Services** page in the Google Cloud console displays the\nversion number for your API. Before deploying your API configuration for the\nfirst time:\n\n- Set the version number in the `info.version` field to the applicable\n API version,for example, `1.0`.\n\n- Set the `basePath` field to the major version number, for example, `/v1`.\n\nFor additional information on versioning your API, see\n[API lifecycle management](/endpoints/docs/openapi/lifecycle-management).\n\n`operationId`\n-------------\n\nAlthough the `operationId` is an optional field in the OpenAPI Specification,\nEndpoints requires this field because it is used for internal\nidentification of the operation. The string that you use for the `operationId`\nmust be unique within your API. See the description for\n[`operationId`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#operation-object)\nin the OpenAPI Specification for guidance on naming.\n\nWhat's next\n-----------\n\n- [Deploying the Endpoints configuration](/endpoints/docs/openapi/deploy-endpoints-config)\n- [Deploying the API backend](/endpoints/docs/openapi/deploy-api-backend)\n- [Configuring authentication](/endpoints/docs/openapi/authentication-method)"]]
