禁用Introspection时获取GraphQL规范及Wiki.js API方案咨询

开发者可采用的途径 #

• 从已知请求反向推导：先调用官方文档提供的示例查询/突变，比如query { pages { id title createdAt } }，分析返回的字段结构，再逐步尝试添加其他字段、嵌套查询，以此摸索出更多可用的类型和操作。
• 查阅项目源码：Wiki.js是开源项目，直接去源码仓库找到GraphQL相关目录（通常是server/graphql），里面的.graphql文件或JS/TS代码里会有完整的Schema定义，包括所有类型、查询、突变的细节。
• 捕获前端请求分析：利用浏览器开发者工具的网络面板，抓取Wiki.js前端自身发送的GraphQL请求，这些请求覆盖了系统常用的操作，分析请求的结构和返回数据，能整理出大量可用的API规范。
• 社区互助交流：加入Wiki.js相关的开发者社群，和其他使用该API的开发者交流，分享各自摸索出的Schema片段、常用操作，互补信息缺口。

管理员可提供Schema的替代方案 #

1. 导出完整Schema文件 #

管理员可以在服务器端通过命令导出Schema：

• 安装Apollo CLI：npm install -g apollo
• 使用授权token调用导出命令（替换为实际的API地址和管理员token）：

  apollo schema:download --endpoint=https://your-wiki-instance/graphql --header="Authorization: Bearer ADMIN_TOKEN" schema.graphql
  

  导出后将schema.graphql文件分发给授权开发者即可。

2. 生成静态文档 #

将导出的Schema转换成易读的静态文档：

• 使用GraphQL Code Generator，配置生成Markdown文档的插件，把Schema转换成结构化的文档，方便开发者查阅。
• 或者用GraphiQL的导出功能，生成包含Schema详情的静态页面，分发给开发者。

3. 搭建内部受限的GraphiQL服务 #

管理员可以部署一个仅对内开放的GraphiQL实例：

• 这个实例连接到主Wiki.js的GraphQL API，但单独启用自省功能。
• 通过内部网络访问限制、身份验证（比如和公司SSO集成），只允许授权开发者访问，这样既不影响主API的安全，又能让开发者直观查看和测试完整Schema。

4. 整理核心场景Schema片段 #

如果导出完整Schema有障碍，管理员可以手动整理常用的查询、突变和对应的类型定义，比如页面增删改查、用户权限管理等核心操作，写成简洁的文档分发给开发者，覆盖大部分日常开发需求。

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