记录与探索您的模式
让您的 GraphQL API 更易于使用：编写高质量的模式文档，利用内省，并使用 GraphiQL 帮助开发者轻松发现和试用您的 API。
记录与探索您的模式 是 CoddyKit 上的免费 GraphQL APIs with Spring Boot 课时。 这是第 4 节课，共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 GraphQL APIs with Spring Boot 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 GraphQL APIs with Spring Boot 课程共包含 4 节课。
本课时的部分内容尚未翻译，以英文显示。
The Schema Is the Documentation
One of GraphQL's superpowers is that the schema is strongly typed and self-describing. With a little care, your schema becomes living documentation that never drifts from reality.
Describing Types and Fields
Add a description by writing a string literal directly above any type or field in the SDL. Tools surface these as inline docs.
type Book {
"The book's unique identifier"
id: ID!
"Full title as printed on the cover"
title: String!
}Multi-line Descriptions
Triple-quoted strings allow rich, multi-line descriptions, perfect for explaining complex fields or usage notes.
"""
Returns paginated books.
Use first and after for cursor pagination.
"""
books(first: Int, after: String): BookConnection!What Is Introspection?
Introspection is GraphQL's built-in ability to query its own schema. Clients can ask what types, fields, and arguments exist, powering autocompletion and docs.
An Introspection Query
The special __schema field returns the full type system. This is how tools like GraphiQL learn about your API.
query {
__schema {
types { name description }
}
}GraphiQL in Spring Boot
Spring for GraphQL ships an embedded GraphiQL playground. Enable it in configuration to get an interactive in-browser explorer.
# application.yml
spring:
graphql:
graphiql:
enabled: trueExploring with GraphiQL
GraphiQL combines a query editor, live autocompletion, and a docs panel built from introspection. Developers can discover and run queries without external documentation.
Deprecating Fields Gracefully
Instead of removing a field, mark it @deprecated with a reason. Tools dim it and show the message, guiding clients to the replacement.
type User {
fullName: String @deprecated(reason: "Use firstName and lastName")
}Disabling Introspection in Production
Introspection is great for development but can expose your full schema to attackers. Many teams disable it in production to reduce information leakage.
spring:
graphql:
schema:
introspection:
enabled: falseGenerating Static Docs
For external partners, generate static HTML or Markdown docs from the schema using tools like SpectaQL or Magidoc, giving a polished reference without exposing a live endpoint.
Best Practices
Keep your API discoverable:
- Describe every public type and field
- Deprecate instead of deleting
- Use GraphiQL in dev, lock down introspection in prod
- Publish static docs for external consumers
Quick Check
Test your documentation knowledge.
Recap
You made your API approachable:
- Add descriptions so the schema documents itself
- Introspection powers tooling and discovery
- GraphiQL gives an interactive explorer in dev
- Deprecate gracefully and lock down introspection in prod
Good documentation and exploration tools make your GraphQL API a pleasure to use.
常见问题解答
「记录与探索您的模式」课时是免费的吗？
是的 — 「记录与探索您的模式」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 GraphQL APIs with Spring Boot 课程的其余内容，请升级到 CoddyKit PRO。 GraphQL APIs with Spring Boot 课程共包含 4 节课。
「记录与探索您的模式」这节课中我会学到什么？
让您的 GraphQL API 更易于使用：编写高质量的模式文档，利用内省，并使用 GraphiQL 帮助开发者轻松发现和试用您的 API。 你通过在浏览器中直接运行的动手代码来练习 GraphQL APIs with Spring Boot，全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 GraphQL APIs with Spring Boot 需要有经验吗？
无需任何先前经验。CoddyKit 上的 GraphQL APIs with Spring Boot 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。 这是第 4 节课，共 4 节。
「记录与探索您的模式」课时需要多长时间？
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。
我能在这节 GraphQL APIs with Spring Boot 课中编写并运行代码吗？
能。每节 GraphQL APIs with Spring Boot 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。