API 套件

這些 NPM 套件匯出開發人員 API，這些 API 在所有 Rush Stack 專案的整合 API 參考中都有說明文件。

• @microsoft/api-extractor API 文件

  這用於從工具鏈呼叫 API Extractor 引擎。 呼叫 API Extractor教學課程中提供了一個程式碼範例。

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

  這用於讀取 .api.json 資料模型，例如用於實作自訂文件工具。此套件的 NPM 頁面 顯示了一個程式碼範例。

• @microsoft/api-documenter API 文件

  這用於建立可自訂 API Documenter 工具輸出的外掛程式。這是一項實驗性的新功能。如需使用範例，請查看 repo-scripts/doc-plugin-rush-stack 專案，該專案將 Jekyll 標題新增至 API Documenter 的 Markdown 輸出中。 repo-scripts/generate-api-docs 專案使用此外掛程式來產生 Rush Stack API 參考。它可以透過執行 generate-api-docs.cmd 腳本來呼叫。外掛程式是在 api-documenter.json 設定檔中註冊的。 api-documenter-template.json 檔案範本包含所有設定的文件。