如何在Spring Boot中修改GraphQL接口的访问端点URL

配置失效的核心原因 #

你之前尝试的两类配置均未生效，是因为选错了配置目标：graphiql节点下的所有属性，都是用于控制GraphQL可视化调试页面的访问地址、以及页面内预置的后端请求地址，并非GraphQL服务本身的核心路由端点配置，自然不会修改接口的实际访问路径。

具体配置方式 #

根据项目引入的GraphQL启动依赖不同，对应配置项有区别，可对照以下两类场景选择：

场景1：使用Spring官方提供的GraphQL Starter（适配Spring Boot 2.7+ / 3.x 版本） #

在application.yml中添加核心路径配置，直接指定GraphQL服务的对外访问地址：

spring:
  graphql:
    # 核心配置项：指定GraphQL接口的实际访问路径
    path: /api/graphql
    graphiql:
      enabled: true
      # 同步调整GraphiQL调试页面的访问路径，避免页面404
      path: /api/graphiql

配置完成后，原有/graphql的默认路径会失效，所有GraphQL请求将被路由到/api/graphql端点。

场景2：使用早期第三方开源GraphQL Starter（依赖包为com.graphql-java:graphql-spring-boot-starter，适配低版本Spring Boot 2.x） #

旧版第三方依赖的配置项不挂在spring节点下，直接在配置文件的根级添加对应配置即可：

# 核心配置项：指定GraphQL接口的实际访问路径
graphql:
  path: /api/graphql
  graphiql:
    enabled: true
    # 同步调整GraphiQL调试页面的访问路径
    path: /api/graphiql

配置验证步骤 #

• 启动项目后，直接向http://localhost:XXXX/api/graphql发送POST请求，携带基础GraphQL查询体验证接口连通性
• 访问调整后的GraphiQL调试页面地址，确认页面可正常加载、且内置的请求端点已自动指向/api/graphql，无路由报错

内容的提问来源于stack exchange，提问作者Ankit Singh