Microsoft.DocAsCode.Build.RestApi 2.63.1

Prefix Reserved
Suggested Alternatives

Docfx.Build.RestApi

Additional Details

Docfx has been fully transitioned to be a .NET Foundation project entirely driven by the community for the interest of the community. Hence we are renaming the NuGet package names, assembly names and namespace names from Microsoft.DocAsCode.* to Docfx.*.

There is a newer version of this package available.
See the version list below for details.
dotnet add package Microsoft.DocAsCode.Build.RestApi --version 2.63.1                
NuGet\Install-Package Microsoft.DocAsCode.Build.RestApi -Version 2.63.1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Microsoft.DocAsCode.Build.RestApi" Version="2.63.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Microsoft.DocAsCode.Build.RestApi --version 2.63.1                
#r "nuget: Microsoft.DocAsCode.Build.RestApi, 2.63.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Microsoft.DocAsCode.Build.RestApi as a Cake Addin
#addin nuget:?package=Microsoft.DocAsCode.Build.RestApi&version=2.63.1

// Install Microsoft.DocAsCode.Build.RestApi as a Cake Tool
#tool nuget:?package=Microsoft.DocAsCode.Build.RestApi&version=2.63.1                

Build your docs with docfx

NuGet Help Wanted Gitter

Build your technical documentation site with docfx, with landing pages, markdown, API reference docs for .NET, REST API and more.

⚠️⚠️⚠️ NOTICE ⚠️⚠️⚠️

Getting Started

  1. Install docfx as a global tool:

    dotnet tool install -g docfx
    
  2. Create and start a website locally:

    docfx init -q
    docfx docfx_project\docfx.json --serve
    
  3. Go to https://localhost:8080 to see the sample site.

For more information, refer to Getting Started.

Contributing

Use Discussions for questions and general discussions. Use Issues to report bugs and proposing features.

We welcome code contributions through pull requests, issues tagged as help-wanted are good candidate to start contributing code.

Prerequisites

Build and Test

  • Build site templates in templates directory:
    • Run npm install to restore npm dependencies.
    • Run npm run build to build the templates.
  • Run dotnet build to build the project or use Visual Studio to build docfx.sln.
  • Run dotnet test to test the project or use Visual Studio test explorer.
    • Run git lfs checkout to checkout files for snapshot testing

Branch and Release

The main branch is the default branch for pull requests and most other development activities. We occationally use feature/* branches for epic feature development.

Releases are based on a stable main branch commit using GitHub Releases. Use of Conventional Commit is encouraged.

Docfx is not released under a regular cadence, new versions arrive when maintainers see enough changes that warrant a new releases. Sometimes we use prereleases to dogfood breaking changes and get feedbacks from the community.

Roadmap

We use Milestones to communicate upcoming changes docfx:

  • Working Set are features being actively worked on. Not every features in this bucket will be committed in the next release but they reflect top of minds of maintainers in the upcoming period.

  • Backlog is a set of feature candidates for some future releases, but are not being actively worked on.

.NET Foundation

This project is supported by the .NET Foundation.

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

License

This project is licensed under the MIT License.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Microsoft.DocAsCode.Build.RestApi:

Package Downloads
Microsoft.DocAsCode.App

Docfx published as a library for extensibility and advanced customization

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.67.5 9,331 6/21/2023 2.67.5 is deprecated because it is no longer maintained.
2.67.3 1,581 6/2/2023 2.67.3 is deprecated because it is no longer maintained.
2.67.2 453 5/26/2023 2.67.2 is deprecated because it is no longer maintained.
2.67.1 522 5/16/2023 2.67.1 is deprecated because it is no longer maintained.
2.67.0 914 5/6/2023 2.67.0 is deprecated because it is no longer maintained.
2.66.2 4,840 4/26/2023 2.66.2 is deprecated because it is no longer maintained.
2.66.1 335 4/25/2023 2.66.1 is deprecated because it is no longer maintained.
2.66.0 391 4/24/2023 2.66.0 is deprecated because it is no longer maintained.
2.65.3 437 4/14/2023 2.65.3 is deprecated because it is no longer maintained.
2.65.2 415 4/11/2023 2.65.2 is deprecated because it is no longer maintained.
2.65.1 373 4/9/2023 2.65.1 is deprecated because it is no longer maintained.
2.65.0 399 4/7/2023 2.65.0 is deprecated because it is no longer maintained.
2.64.0 528 3/30/2023 2.64.0 is deprecated because it is no longer maintained.
2.63.1 672 3/21/2023 2.63.1 is deprecated because it is no longer maintained.
2.63.0 429 3/20/2023 2.63.0 is deprecated because it is no longer maintained.
2.62.2 479 3/7/2023 2.62.2 is deprecated because it is no longer maintained.
2.62.1 1,898 2/15/2023 2.62.1 is deprecated because it is no longer maintained.
2.62.0 405 2/14/2023 2.62.0 is deprecated because it is no longer maintained.
2.61.0 2,371 1/30/2023 2.61.0 is deprecated because it is no longer maintained.
2.60.2 863 1/20/2023 2.60.2 is deprecated because it is no longer maintained.
2.60.1 507 1/18/2023 2.60.1 is deprecated because it is no longer maintained.
2.60.0 946 1/13/2023 2.60.0 is deprecated because it is no longer maintained.
2.60.0-preview.2 140 12/25/2022 2.60.0-preview.2 is deprecated because it is no longer maintained.
2.60.0-preview.1 136 12/20/2022 2.60.0-preview.1 is deprecated because it is no longer maintained.
2.59.4 6,820 9/7/2022 2.59.4 is deprecated because it is no longer maintained.
2.59.3 1,152 7/6/2022 2.59.3 is deprecated because it is no longer maintained.
2.59.2 1,092 4/11/2022 2.59.2 is deprecated because it is no longer maintained.
2.59.1 730 3/31/2022 2.59.1 is deprecated because it is no longer maintained.
2.59.0 1,005 1/19/2022 2.59.0 is deprecated because it is no longer maintained.
2.58.9 794 11/4/2021 2.58.9 is deprecated because it is no longer maintained.
2.58.8 533 11/1/2021 2.58.8 is deprecated because it is no longer maintained.
2.58.5 527 10/26/2021 2.58.5 is deprecated because it is no longer maintained.
2.58.4 607 9/14/2021 2.58.4 is deprecated because it is no longer maintained.
2.58.3 538 9/7/2021 2.58.3 is deprecated because it is no longer maintained.
2.58.2 754 8/24/2021 2.58.2 is deprecated because it is no longer maintained.
2.58.1 520 8/23/2021 2.58.1 is deprecated because it is no longer maintained.
2.58.0 746 6/9/2021 2.58.0 is deprecated because it is no longer maintained.
2.57.2 657 4/14/2021 2.57.2 is deprecated because it is no longer maintained.
2.57.1 549 4/13/2021 2.57.1 is deprecated because it is no longer maintained.
2.57.0 611 4/9/2021 2.57.0 is deprecated because it is no longer maintained.
2.56.7 1,741 3/2/2021 2.56.7 is deprecated because it is no longer maintained.
2.56.6 1,447 12/10/2020 2.56.6 is deprecated because it is no longer maintained.
2.56.5 707 11/10/2020 2.56.5 is deprecated because it is no longer maintained.
2.56.4 1,043 10/20/2020 2.56.4 is deprecated because it is no longer maintained.
2.56.3 734 10/12/2020 2.56.3 is deprecated because it is no longer maintained.
2.56.2 872 7/27/2020 2.56.2 is deprecated because it is no longer maintained.
2.56.1 702 7/6/2020 2.56.1 is deprecated because it is no longer maintained.
2.56.0 766 6/29/2020 2.56.0 is deprecated because it is no longer maintained.
2.55.0 786 6/12/2020 2.55.0 is deprecated because it is no longer maintained.
2.53.1 862 5/11/2020 2.53.1 is deprecated because it is no longer maintained.
2.52.0 1,119 4/13/2020 2.52.0 is deprecated because it is no longer maintained.
2.51.0 990 3/20/2020 2.51.0 is deprecated because it is no longer maintained.
2.50.0 993 3/2/2020 2.50.0 is deprecated because it is no longer maintained.
2.49.0 854 2/17/2020 2.49.0 is deprecated because it is no longer maintained.
2.48.1 2,221 1/13/2020 2.48.1 is deprecated because it is no longer maintained.
2.48.0 1,145 12/9/2019 2.48.0 is deprecated because it is no longer maintained.
2.47.0 1,140 10/31/2019 2.47.0 is deprecated because it is no longer maintained.
2.46.0 1,097 10/14/2019 2.46.0 is deprecated because it is no longer maintained.
2.45.1 1,166 9/15/2019 2.45.1 is deprecated because it is no longer maintained.
2.45.0 1,089 8/25/2019 2.45.0 is deprecated because it is no longer maintained.
2.44.0 1,108 8/2/2019 2.44.0 is deprecated because it is no longer maintained.
2.43.2 1,448 7/2/2019 2.43.2 is deprecated because it is no longer maintained.
2.43.1 943 6/14/2019 2.43.1 is deprecated because it is no longer maintained.
2.42.4 1,733 5/24/2019 2.42.4 is deprecated because it is no longer maintained.
2.42.3 12,947 5/13/2019 2.42.3 is deprecated because it is no longer maintained.
2.42.2 844 5/10/2019 2.42.2 is deprecated because it is no longer maintained.
2.42.0 953 4/22/2019 2.42.0 is deprecated because it is no longer maintained.
2.41.0 1,324 3/29/2019 2.41.0 is deprecated because it is no longer maintained.
2.40.12 935 3/11/2019 2.40.12 is deprecated because it is no longer maintained.
2.40.11 1,082 2/16/2019 2.40.11 is deprecated because it is no longer maintained.
2.40.10 965 2/1/2019 2.40.10 is deprecated because it is no longer maintained.
2.40.9 943 1/31/2019 2.40.9 is deprecated because it is no longer maintained.
2.40.8 972 1/25/2019 2.40.8 is deprecated because it is no longer maintained.
2.40.7 1,046 1/4/2019 2.40.7 is deprecated because it is no longer maintained.
2.40.5 953 12/19/2018 2.40.5 is deprecated because it is no longer maintained.
2.40.4 1,016 11/26/2018 2.40.4 is deprecated because it is no longer maintained.
2.40.2 1,090 11/7/2018 2.40.2 is deprecated because it is no longer maintained.
2.40.1 1,045 10/29/2018 2.40.1 is deprecated because it is no longer maintained.
2.40.0 1,089 10/12/2018 2.40.0 is deprecated because it is no longer maintained.
2.39.2 2,151 9/9/2018 2.39.2 is deprecated because it is no longer maintained.
2.39.1 2,503 9/4/2018 2.39.1 is deprecated because it is no longer maintained.
2.39.0 1,261 9/2/2018 2.39.0 is deprecated because it is no longer maintained.
2.38.1 5,831 8/16/2018 2.38.1 is deprecated because it is no longer maintained.
2.38.0 1,366 8/13/2018 2.38.0 is deprecated because it is no longer maintained.
2.37.2 1,287 7/31/2018 2.37.2 is deprecated because it is no longer maintained.
2.37.1 1,236 7/31/2018 2.37.1 is deprecated because it is no longer maintained.
2.36.2 1,387 6/13/2018 2.36.2 is deprecated because it is no longer maintained.
2.36.1 1,383 5/25/2018 2.36.1 is deprecated because it is no longer maintained.
2.36.0 1,286 5/21/2018 2.36.0 is deprecated because it is no longer maintained.
2.36.0-alpha-0159-g25e5900b4 928 4/26/2018 2.36.0-alpha-0159-g25e5900b4 is deprecated because it is no longer maintained.
2.35.4 1,353 5/2/2018 2.35.4 is deprecated because it is no longer maintained.
2.35.3 1,464 5/2/2018 2.35.3 is deprecated because it is no longer maintained.
2.35.0-alpha-0153-g6da267dd4 908 4/25/2018 2.35.0-alpha-0153-g6da267dd4 is deprecated because it is no longer maintained.
2.33.2 1,393 4/3/2018 2.33.2 is deprecated because it is no longer maintained.
2.33.1 1,368 4/3/2018 2.33.1 is deprecated because it is no longer maintained.
2.33.0 1,367 3/19/2018 2.33.0 is deprecated because it is no longer maintained.
2.32.2 1,357 3/12/2018 2.32.2 is deprecated because it is no longer maintained.
2.32.0 1,427 2/28/2018 2.32.0 is deprecated because it is no longer maintained.
2.31.0 1,405 2/5/2018 2.31.0 is deprecated because it is no longer maintained.
2.30.0 1,415 1/12/2018 2.30.0 is deprecated because it is no longer maintained.
2.29.1 1,365 12/29/2017 2.29.1 is deprecated because it is no longer maintained.
2.28.3 1,271 12/14/2017 2.28.3 is deprecated because it is no longer maintained.
2.28.2 1,280 12/7/2017 2.28.2 is deprecated because it is no longer maintained.
2.28.1 1,296 12/1/2017 2.28.1 is deprecated because it is no longer maintained.
2.28.0 1,300 11/30/2017 2.28.0 is deprecated because it is no longer maintained.
2.27.0 1,320 11/21/2017 2.27.0 is deprecated because it is no longer maintained.
2.26.3 1,342 10/26/2017 2.26.3 is deprecated because it is no longer maintained.
2.26.1 1,336 10/24/2017 2.26.1 is deprecated because it is no longer maintained.
2.26.0 1,275 10/23/2017 2.26.0 is deprecated because it is no longer maintained.
2.25.1 1,287 10/9/2017 2.25.1 is deprecated because it is no longer maintained.
2.25.0 1,333 10/9/2017 2.25.0 is deprecated because it is no longer maintained.
2.24.0 1,399 9/11/2017 2.24.0 is deprecated because it is no longer maintained.
2.23.1 1,323 8/22/2017 2.23.1 is deprecated because it is no longer maintained.
2.22.3 1,293 8/17/2017 2.22.3 is deprecated because it is no longer maintained.
2.22.1 1,361 8/2/2017 2.22.1 is deprecated because it is no longer maintained.
2.22.0 1,347 8/1/2017 2.22.0 is deprecated because it is no longer maintained.
2.21.2 1,311 7/26/2017 2.21.2 is deprecated because it is no longer maintained.
2.21.1 1,319 7/17/2017 2.21.1 is deprecated because it is no longer maintained.
2.20.0 1,354 7/12/2017 2.20.0 is deprecated because it is no longer maintained.
2.19.2 1,322 6/29/2017 2.19.2 is deprecated because it is no longer maintained.
2.18.5 1,347 6/15/2017 2.18.5 is deprecated because it is no longer maintained.
2.18.4 1,320 6/9/2017 2.18.4 is deprecated because it is no longer maintained.
2.18.3 1,322 6/8/2017 2.18.3 is deprecated because it is no longer maintained.
2.18.1 1,354 5/31/2017 2.18.1 is deprecated because it is no longer maintained.
2.17.5 1,332 5/23/2017 2.17.5 is deprecated because it is no longer maintained.
2.17.3 1,304 5/11/2017 2.17.3 is deprecated because it is no longer maintained.
2.17.2 1,306 5/9/2017 2.17.2 is deprecated because it is no longer maintained.
2.16.8 1,309 5/3/2017 2.16.8 is deprecated because it is no longer maintained.
2.16.7 1,377 4/26/2017 2.16.7 is deprecated because it is no longer maintained.
2.16.5 1,333 4/25/2017 2.16.5 is deprecated because it is no longer maintained.
2.16.2 1,339 4/20/2017 2.16.2 is deprecated because it is no longer maintained.
2.16.0 1,350 4/17/2017 2.16.0 is deprecated because it is no longer maintained.
2.15.5 1,683 4/6/2017 2.15.5 is deprecated because it is no longer maintained.
2.15.2 1,657 3/29/2017 2.15.2 is deprecated because it is no longer maintained.
2.13.1 1,673 3/7/2017 2.13.1 is deprecated because it is no longer maintained.
2.13.0 1,636 3/6/2017 2.13.0 is deprecated because it is no longer maintained.
2.12.1 1,595 2/14/2017 2.12.1 is deprecated because it is no longer maintained.
2.12.0 1,605 2/13/2017 2.12.0 is deprecated because it is no longer maintained.
2.11.3 1,556 2/7/2017 2.11.3 is deprecated because it is no longer maintained.
2.11.2 1,575 1/25/2017 2.11.2 is deprecated because it is no longer maintained.
2.11.1 1,547 1/24/2017 2.11.1 is deprecated because it is no longer maintained.
2.11.0 1,568 1/23/2017 2.11.0 is deprecated because it is no longer maintained.
2.10.2 1,601 1/4/2017 2.10.2 is deprecated because it is no longer maintained.
2.10.1 1,600 1/4/2017 2.10.1 is deprecated because it is no longer maintained.
2.10.0 1,615 1/3/2017 2.10.0 is deprecated because it is no longer maintained.
2.9.3 1,675 12/15/2016 2.9.3 is deprecated because it is no longer maintained.
2.9.2 1,655 12/14/2016 2.9.2 is deprecated because it is no longer maintained.
2.9.1 1,639 12/13/2016 2.9.1 is deprecated because it is no longer maintained.
2.9.0 1,716 12/12/2016 2.9.0 is deprecated because it is no longer maintained.
2.8.2 1,645 11/28/2016 2.8.2 is deprecated because it is no longer maintained.
2.8.1 1,626 11/24/2016 2.8.1 is deprecated because it is no longer maintained.
2.8.0 1,668 11/22/2016 2.8.0 is deprecated because it is no longer maintained.
2.7.3 1,974 11/8/2016 2.7.3 is deprecated because it is no longer maintained.
2.7.2 1,861 11/3/2016 2.7.2 is deprecated because it is no longer maintained.
2.7.1 1,892 11/1/2016 2.7.1 is deprecated because it is no longer maintained.
2.7.0 1,616 10/31/2016 2.7.0 is deprecated because it is no longer maintained.
2.6.3 1,637 10/25/2016 2.6.3 is deprecated because it is no longer maintained.
2.6.1 1,588 10/11/2016 2.6.1 is deprecated because it is no longer maintained.
2.6.0 1,618 10/10/2016 2.6.0 is deprecated because it is no longer maintained.
2.5.4 2,092 9/22/2016 2.5.4 is deprecated because it is no longer maintained.
2.5.3 1,969 9/20/2016 2.5.3 is deprecated because it is no longer maintained.
2.5.2 1,763 9/19/2016 2.5.2 is deprecated because it is no longer maintained.
2.5.1 1,891 9/19/2016 2.5.1 is deprecated because it is no longer maintained.
2.5.0 1,630 9/14/2016 2.5.0 is deprecated because it is no longer maintained.
2.4.0 1,503 8/29/2016 2.4.0 is deprecated because it is no longer maintained.
2.3.1 1,500 8/22/2016 2.3.1 is deprecated because it is no longer maintained.
2.3.0 1,626 8/8/2016 2.3.0 is deprecated because it is no longer maintained.
2.2.2 1,565 7/22/2016 2.2.2 is deprecated because it is no longer maintained.
2.2.1 1,534 7/19/2016 2.2.1 is deprecated because it is no longer maintained.
2.2.0 1,530 7/18/2016 2.2.0 is deprecated because it is no longer maintained.
2.1.0 1,589 6/27/2016 2.1.0 is deprecated because it is no longer maintained.
2.0.2 1,564 6/22/2016 2.0.2 is deprecated because it is no longer maintained.
2.0.1 1,613 6/7/2016 2.0.1 is deprecated because it is no longer maintained.
2.0.0 1,571 6/6/2016 2.0.0 is deprecated because it is no longer maintained.
1.9.4 1,804 5/19/2016 1.9.4 is deprecated because it is no longer maintained.
1.9.3 1,560 5/19/2016 1.9.3 is deprecated because it is no longer maintained.
1.9.0 1,553 5/16/2016 1.9.0 is deprecated because it is no longer maintained.
1.8.4 1,552 5/10/2016 1.8.4 is deprecated because it is no longer maintained.
1.8.1 1,569 5/4/2016 1.8.1 is deprecated because it is no longer maintained.
1.8.0 1,839 4/25/2016 1.8.0 is deprecated because it is no longer maintained.
1.7.2 1,584 4/20/2016 1.7.2 is deprecated because it is no longer maintained.
1.7.1 1,623 4/7/2016 1.7.1 is deprecated because it is no longer maintained.
1.7.0 1,766 4/6/2016 1.7.0 is deprecated because it is no longer maintained.