# 为 API 编写文档

- [OpenAPI](/docs/documentation/zh/api-references/openapi.md): 向页面添加 OpenAPI 规范，让用户通过交互式块直接在页面上测试端点。
- [添加 OpenAPI 规范](/docs/documentation/zh/api-references/openapi/add-an-openapi-specification.md): 了解如何在 GitBook 应用中或通过 CLI 添加和更新 OpenAPI 规范
- [在文档中插入 API 参考](/docs/documentation/zh/api-references/openapi/insert-api-reference-in-your-docs.md): 从你的 OpenAPI 规范中插入完整的 API 参考，或选择单个操作或架构
- [指南](/docs/documentation/zh/api-references/guides.md)
- [构建 API 参考的结构](/docs/documentation/zh/api-references/guides/structuring-your-api-reference.md): 了解如何使用图标和描述在多个页面中组织你的 API 参考
- [添加自定义代码示例](/docs/documentation/zh/api-references/guides/adding-custom-code-samples.md): 了解如何配置自定义代码示例，以便与 API 端点一起显示
- [管理 API 操作](/docs/documentation/zh/api-references/guides/managing-api-operations.md): 了解如何将 OpenAPI API 操作标记为实验性、已弃用，或将其从文档中隐藏
- [配置“测试它”按钮](/docs/documentation/zh/api-references/guides/configuring-the-test-it-button.md)
- [使用 OpenAPI 代理](/docs/documentation/zh/api-references/guides/using-openapi-proxy.md)
- [描述枚举](/docs/documentation/zh/api-references/guides/describing-enums.md): 了解如何为枚举添加描述
- [与 CI/CD 集成](/docs/documentation/zh/api-references/guides/support-for-ci-cd-with-api-blocks.md): 了解如何在 GitBook 中自动更新你的 OpenAPI 规范
- [扩展参考](/docs/documentation/zh/api-references/extensions-reference.md): GitBook 支持的 OpenAPI 扩展完整参考