Microsoft.DocAsCode.DataContracts.RestApi 2.67.5
保留前缀
Docfx 已完全转变为一个由社区完全驱动、旨在为社区利益服务的 .NET 基金会项目。因此,我们将 NuGet 包名、程序集名和命名空间名从 Microsoft.DocAsCode.* 更改为 Docfx.*。
dotnet add package Microsoft.DocAsCode.DataContracts.RestApi --version 2.67.5
NuGet\Install-Package Microsoft.DocAsCode.DataContracts.RestApi -Version 2.67.5
<PackageReference Include="Microsoft.DocAsCode.DataContracts.RestApi" Version="2.67.5" />
paket add Microsoft.DocAsCode.DataContracts.RestApi --version 2.67.5
#r "nuget: Microsoft.DocAsCode.DataContracts.RestApi, 2.67.5"
// Install Microsoft.DocAsCode.DataContracts.RestApi as a Cake Addin #addin nuget:?package=Microsoft.DocAsCode.DataContracts.RestApi&version=2.67.5 // Install Microsoft.DocAsCode.DataContracts.RestApi as a Cake Tool #tool nuget:?package=Microsoft.DocAsCode.DataContracts.RestApi&version=2.67.5
使用 docfx 构建您的文档
使用 docfx 构建您的技术文档网站,包括着陆页面、Markdown、.NET、REST API 的 API 引用文档等。
⚠️⚠️⚠️ 注意事项 ⚠️⚠️⚠️
DocFX 正在过渡到 .NET Foundation,作为一个官方 .NET 项目!
- DocFX 团队正在改进主分支。这将向项目引入新功能和错误修复,删除一些不再必要的较旧代码和功能,以及更新依赖项并简化项目结构。请关注路线图。
- 由于网站架构的改变,(请点击查看详细讨论),DocFX 现已无法直接构建 Microsoft Learn 内容。依然可以接受持有 Microsoft Learn Markdown 内容的开源仓库的拉取请求和更改,但这些内容无法使用 DocFX 直接构建。
- 未来,我们只会将此工具作为新网站的静态站点生成器进行支持,而不是作为在 Microsoft Learn 上构建官方微软内容的工具。
入门
将 docfx 安装为全局工具
dotnet tool install -g docfx
在本地创建和启动一个网站
docfx init -q docfx build docfx_project\docfx.json --serve
前往 https://localhost:8080 查看示例网站。
有关更多信息,请参阅入门指南。
贡献
请使用讨论提问和进行一般讨论。使用问题报告错误和建议新功能。
我们欢迎通过拉取请求进行代码贡献,带有**help-wanted
**标记的问题很好的开始贡献代码的机会。
先决条件
- 安装 Visual Studio 2022(社区版或更高) 确保您有最新的更新。
- 安装 .NET Core SDK 6.x 和 7.x.
- 安装 NodeJS(16.x.x)。
- 可选:在Windows上安装 wkhtmltopdf 以测试PDF,使用
choco install wkhtmltopdf
。
构建和测试
- 在
templates
目录中构建网站模板- 运行
npm install
以恢复 npm 依赖项。 - 运行
npm run build
构建模板。
- 运行
- 运行
dotnet build
构建项目或使用 Visual Studio 构建docfx.sln
。 - 运行
dotnet test
测试项目或使用 Visual Studio 测试资源管理器。- 运行
git lfs checkout
检出用于快照测试的文件。
- 运行
分支和发布
main
分支是供拉取请求和大多数其他开发活动使用的默认分支。偶尔,我们会使用 feature/*
分支来进行史诗级功能开发。
版本发布基于稳定的安全 main
分支提交,使用 GitHub发行版。鼓励使用 常规提交。
Docfx 并不按照固定周期发布,新版本在维护者看到足够的更改以支持新版本发布时会发布。有时我们会使用预发布版本来测试破坏性更改并从社区获取反馈。
路线图
我们使用 里程碑 来传达即将到来的 docfx 变更。
现行工作集 是正在积极开发中的功能。并非这个清单中的每个功能都会在下一个版本中加入,但这反映了维护者在即将到来的时间段中的主要关注点。
待办事项列表 是一些未来版本的功能候选集,但它们目前并未被积极开发。
许可
本项目受 MIT 许可协议的约束。
.NET 基金会
本项目由 .NET基金 支持。
本项目采用了贡献者誓言中规定的行为准则,以明确我们社区中期望的行为。更多信息请参阅 .NET基金行为准则。
产品 | 版本 兼容和额外的计算目标框架版本。 |
---|---|
.NET |
-
net6.0
- Microsoft.DocAsCode.Common (>= 2.67.5)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.67.5)
- Microsoft.DocAsCode.YamlSerialization (>= 2.67.5)
-
net7.0
- Microsoft.DocAsCode.Common (>= 2.67.5)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.67.5)
- Microsoft.DocAsCode.YamlSerialization (>= 2.67.5)
-
net8.0
- Microsoft.DocAsCode.Common (>= 2.67.5)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.67.5)
- Microsoft.DocAsCode.YamlSerialization (>= 2.67.5)
NuGet 包 (3)
显示依赖于 Microsoft.DocAsCode.DataContracts.RestApi 的前 3 个 NuGet 包
包 | 下载 |
---|---|
Microsoft.DocAsCode.Build.RestApi 包描述 |
|
Microsoft.DocAsCode.Build.TagLevelRestApi 包描述 |
|
Microsoft.DocAsCode.Build.OperationLevelRestApi 包描述 |
GitHub 存储库
此包未被任何流行的GitHub存储库使用。
版本 | 下载 | 最后更新 | |
---|---|---|---|
2.67.5 | 8,695 | 6/21/2023 | |
2.67.3 | 1,629 | 6/2/2023 | |
2.67.2 | 476 | 5/26/2023 | |
2.67.1 | 529 | 5/16/2023 | |
2.67.0 | 951 | 5/6/2023 | |
2.66.2 | 4,745 | 4/26/2023 | |
2.66.1 | 403 | 4/25/2023 | |
2.66.0 | 501 | 4/24/2023 | |
2.65.3 | 523 | 4/14/2023 | |
2.65.2 | 480 | 4/11/2023 | |
2.65.1 | 446 | 4/9/2023 | |
2.65.0 | 499 | 4/7/2023 | |
2.64.0 | 623 | 3/30/2023 | |
2.63.1 | 752 | 3/21/2023 | |
2.63.0 | 542 | 3/20/2023 | |
2.62.2 | 601 | 3/7/2023 | |
2.62.1 | 2,033 | 2/15/2023 | |
2.62.0 | 565 | 2/14/2023 | |
2.61.0 | 2,543 | 1/30/2023 | |
2.60.2 | 1,002 | 1/20/2023 | |
2.60.1 | 645 | 1/18/2023 | |
2.60.0 | 1,078 | 1/13/2023 | |
2.60.0-preview.2 | 130 | 12/25/2022 | |
2.60.0-preview.1 | 130 | 12/20/2022 | |
2.59.4 | 6,532 | 9/7/2022 | |
2.59.3 | 1,385 | 7/6/2022 | |
2.59.2 | 1,359 | 4/11/2022 | |
2.59.1 | 995 | 3/31/2022 | |
2.59.0 | 970 | 1/19/2022 | |
2.58.9 | 651 | 11/4/2021 | |
2.58.8 | 457 | 11/1/2021 | |
2.58.5 | 458 | 10/26/2021 | |
2.58.4 | 534 | 9/14/2021 | |
2.58.3 | 513 | 9/7/2021 | |
2.58.2 | 742 | 8/24/2021 | |
2.58.1 | 478 | 8/23/2021 | |
2.58.0 | 727 | 6/9/2021 | |
2.57.2 | 629 | 4/14/2021 | |
2.57.1 | 508 | 4/13/2021 | |
2.57.0 | 565 | 4/9/2021 | |
2.56.7 | 1,683 | 3/2/2021 | |
2.56.6 | 1,360 | 12/10/2020 | |
2.56.5 | 662 | 11/10/2020 | |
2.56.4 | 976 | 10/20/2020 | |
2.56.3 | 660 | 10/12/2020 | |
2.56.2 | 821 | 7/27/2020 | |
2.56.1 | 709 | 7/6/2020 | |
2.56.0 | 768 | 6/29/2020 | |
2.55.0 | 748 | 6/12/2020 | |
2.53.1 | 1,055 | 5/11/2020 | |
2.52.0 | 1,335 | 4/13/2020 | |
2.51.0 | 3,216 | 3/20/2020 | |
2.50.0 | 984 | 3/2/2020 | |
2.49.0 | 747 | 2/17/2020 | |
2.48.1 | 3,152 | 1/13/2020 | |
2.48.0 | 1,537 | 12/9/2019 | |
2.47.0 | 976 | 10/31/2019 | |
2.46.0 | 917 | 10/14/2019 | |
2.45.1 | 2,738 | 9/15/2019 | |
2.45.0 | 912 | 8/25/2019 | |
2.44.0 | 961 | 8/2/2019 | |
2.43.2 | 1,737 | 7/2/2019 | |
2.43.1 | 866 | 6/14/2019 | |
2.42.4 | 1,431 | 5/24/2019 | |
2.42.3 | 13,113 | 5/13/2019 | |
2.42.2 | 770 | 5/10/2019 | |
2.42.0 | 835 | 4/22/2019 | |
2.41.0 | 1,180 | 3/29/2019 | |
2.40.12 | 794 | 3/11/2019 | |
2.40.11 | 1,103 | 2/16/2019 | |
2.40.10 | 847 | 2/1/2019 | |
2.40.9 | 816 | 1/31/2019 | |
2.40.8 | 847 | 1/25/2019 | |
2.40.7 | 932 | 1/4/2019 | |
2.40.5 | 869 | 12/19/2018 | |
2.40.4 | 904 | 11/26/2018 | |
2.40.2 | 986 | 11/7/2018 | |
2.40.1 | 924 | 10/29/2018 | |
2.40.0 | 952 | 10/12/2018 | |
2.39.2 | 1,976 | 9/9/2018 | |
2.39.1 | 2,302 | 9/4/2018 | |
2.39.0 | 6,201 | 9/2/2018 | |
2.38.1 | 5,611 | 8/16/2018 | |
2.38.0 | 1,172 | 8/13/2018 | |
2.37.2 | 1,082 | 7/31/2018 | |
2.37.1 | 1,022 | 7/31/2018 | |
2.36.2 | 1,113 | 6/13/2018 | |
2.36.1 | 1,123 | 5/25/2018 | |
2.36.0 | 1,283 | 5/21/2018 | |
2.36.0-alpha-0159-g25e5900b4 | 875 | 4/26/2018 | |
2.35.4 | 1,237 | 5/2/2018 | |
2.35.3 | 1,219 | 5/2/2018 | |
2.35.0-alpha-0153-g6da267dd4 | 874 | 4/25/2018 | |
2.33.2 | 1,164 | 4/3/2018 | |
2.33.1 | 1,049 | 4/3/2018 | |
2.33.0 | 1,253 | 3/19/2018 | |
2.32.2 | 1,160 | 3/12/2018 | |
2.32.0 | 1,217 | 2/28/2018 | |
2.31.0 | 1,270 | 2/5/2018 | |
2.30.0 | 1,251 | 1/12/2018 | |
2.29.1 | 1,185 | 12/29/2017 | |
2.28.3 | 1,118 | 12/14/2017 | |
2.28.2 | 1,179 | 12/7/2017 | |
2.28.1 | 1,078 | 12/1/2017 | |
2.28.0 | 1,125 | 11/30/2017 | |
2.27.0 | 1,111 | 11/21/2017 | |
2.26.3 | 1,115 | 10/26/2017 | |
2.26.1 | 1,102 | 10/24/2017 | |
2.26.0 | 1,060 | 10/23/2017 | |
2.25.1 | 1,049 | 10/9/2017 | |
2.25.0 | 1,109 | 10/9/2017 | |
2.24.0 | 1,170 | 9/11/2017 | |
2.23.1 | 1,127 | 8/22/2017 | |
2.22.3 | 1,094 | 8/17/2017 | |
2.22.1 | 1,110 | 8/2/2017 | |
2.22.0 | 1,149 | 8/1/2017 | |
2.21.2 | 1,109 | 7/26/2017 | |
2.21.1 | 1,104 | 7/17/2017 | |
2.20.0 | 1,117 | 7/12/2017 | |
2.19.2 | 1,129 | 6/29/2017 | |
2.18.5 | 1,140 | 6/15/2017 | |
2.18.4 | 1,137 | 6/9/2017 | |
2.18.3 | 1,175 | 6/8/2017 | |
2.18.1 | 1,108 | 5/31/2017 | |
2.17.5 | 1,110 | 5/23/2017 | |
2.17.3 | 1,125 | 5/11/2017 | |
2.17.2 | 1,129 | 5/9/2017 | |
2.16.8 | 1,105 | 5/3/2017 | |
2.16.7 | 1,127 | 4/26/2017 | |
2.16.5 | 1,132 | 4/25/2017 | |
2.16.2 | 1,108 | 4/20/2017 | |
2.16.0 | 1,121 | 4/17/2017 | |
2.15.5 | 1,320 | 4/6/2017 | |
2.15.2 | 1,228 | 3/29/2017 | |
2.13.1 | 1,221 | 3/7/2017 | |
2.13.0 | 1,186 | 3/6/2017 | |
2.12.1 | 1,157 | 2/14/2017 | |
2.12.0 | 1,162 | 2/13/2017 | |
2.11.3 | 1,150 | 2/7/2017 | |
2.11.2 | 1,151 | 1/25/2017 | |
2.11.1 | 1,136 | 1/24/2017 | |
2.11.0 | 1,187 | 1/23/2017 | |
2.10.2 | 1,232 | 1/4/2017 | |
2.10.1 | 1,167 | 1/4/2017 | |
2.10.0 | 1,256 | 1/3/2017 | |
2.9.3 | 1,181 | 12/15/2016 | |
2.9.2 | 1,177 | 12/14/2016 | |
2.9.1 | 1,187 | 12/13/2016 | |
2.9.0 | 1,208 | 12/12/2016 | |
2.8.2 | 1,177 | 11/28/2016 | |
2.8.1 | 1,237 | 11/24/2016 | |
2.8.0 | 1,220 | 11/22/2016 | |
2.7.3 | 1,486 | 11/8/2016 | |
2.7.2 | 1,361 | 11/3/2016 | |
2.7.1 | 1,441 | 11/1/2016 | |
2.7.0 | 1,216 | 10/31/2016 | |
2.6.3 | 1,212 | 10/25/2016 | |
2.6.1 | 1,153 | 10/11/2016 | |
2.6.0 | 1,168 | 10/10/2016 | |
2.5.4 | 1,593 | 9/22/2016 | |
2.5.3 | 1,543 | 9/20/2016 | |
2.5.2 | 1,343 | 9/19/2016 | |
2.5.1 | 1,361 | 9/19/2016 | |
2.5.0 | 1,231 | 9/14/2016 | |
2.4.0 | 1,235 | 8/29/2016 | |
2.3.1 | 1,137 | 8/22/2016 | |
2.3.0 | 1,302 | 8/8/2016 | |
2.2.2 | 1,234 | 7/22/2016 | |
2.2.1 | 1,175 | 7/19/2016 | |
2.2.0 | 1,189 | 7/18/2016 | |
2.1.0 | 1,309 | 6/27/2016 |