API 包

这些 NPM 包导出开发者 API，这些 API 在 所有 Rush Stack 项目的集成 API 参考 中有记录。

• @microsoft/api-extractor API 文档

  这用于从工具链中调用 API 提取器引擎。 调用 API 提取器 教程中提供了一个代码示例。

• @microsoft/api-extractor-model API 文档

  这用于读取 .api.json 数据模型，例如实现自定义文档工具。 该包的 NPM 页面 显示了一个代码示例。

• @microsoft/api-documenter API 文档

  这用于创建插件，这些插件可以自定义 API Documenter 工具的输出。 这是一个实验性的新功能。 有关使用示例，请查看 repo-scripts/doc-plugin-rush-stack 项目，该项目 向 API Documenter 的 markdown 输出添加 Jekyll 标题。 repo-scripts/generate-api-docs 项目使用此插件生成 Rush Stack API 参考。 它通过运行 generate-api-docs.cmd 脚本调用。 该插件在 api-documenter.json 配置文件中注册。 api-documenter-template.json 文件模板包含所有设置的文档。