您的 API 服务名称在 Google Cloud上必须是唯一的。由于 Endpoints 使用符合 DNS 规范的名称来识别服务，因此建议您使用 API 的域名或子网域名作为服务名称。使用此方法，Endpoints 服务页面上显示的服务名称会与对 API 的请求中使用的名称相匹配。Endpoints 对服务名称有以下要求：
域名的最大长度为 253 个字符。
域名必须以小写字母开头。
域名中用点分隔开的每个部分均必须满足以下要求：
必须以小写字母开头。
不得以短划线结尾。
其余字符可以是小写字母、数字或短划线。
长度上限为 63 个字符。
您可以注册自己的自定义网域（例如 example.com），也可以使用由 Google 管理的网域。
使用由 Google 管理的网域
cloud.goog 和 appspot.com 网域归 Google 所有并由其管理。如果您想要使用由 Google 管理的网域，则必须在服务名称中包括您的Google Cloud 项目 ID。由于Google Cloud 项目具有全局唯一的项目 ID，因此这项要求可确保您的服务名称是独一无二的。
如果您不想使用由 Google 管理的网域，则可以使用您有权使用的自定义网域（例如 myapi.mycompany.com）。在部署 API 配置之前，请先按照验证网域所有权中的步骤操作。
info.title
info.title 字段是 API 的简单易懂名称。 Google Cloud 控制台中的 Endpoints > Services 页面会显示您在 info.title 字段中配置的文本。如果每个项目都具有多个 API，则在首次打开该页面时，API 名称会在列表中显示。 Google Cloud 您可以点击 API 名称以打开另一个页面，上面显示该 API 的指标、部署历史记录和其他信息。
info.version
Google Cloud 控制台中的 Endpoints > Services 页面会显示 API 的版本号。在首次部署 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"]],["最后更新时间 (UTC)：2025-08-18。"],[[["\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)"]]
