Skip to content

Commit 4429cef

Browse files
ADD readme for APIViewJSON Utility (#9270)
* ADD readme for APIViewJSON Utility
1 parent 16826b8 commit 4429cef

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

  • src/dotnet/APIView/APIViewJsonUtility
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# APIViewJsonUtility
2+
3+
### Overview
4+
5+
APIViewJsonUtility is a .NET utility designed to facilitate the manipulation and processing of JSON data within the APIView ecosystem. This tool helps developers to efficiently handle JSON data structures, making it easier to integrate with APIView's functionalities when working on parser to verify how JSON token file is rendered as output text on APIView without uploading JSON file to APIView.
6+
7+
### Features
8+
9+
- **Create API view output from JSON token**: Parse JSON token file to create the API review output text.
10+
- **Convert to tree token model**: Convert an old flat list tree token JSON file to new tree style JSON token file.
11+
12+
13+
### Prerequisites
14+
15+
- .NET SDK (version 8.0 or later)
16+
17+
### Installation
18+
19+
APIViewJsonUtility is published to Azure DevOps artifact. You can install this .NET tool from [azure-sdk-for-net feed](https://dev.azure.com/azure-sdk/public/_artifacts/feed/azure-sdk-for-net/NuGet/APIViewJsonTool/overview) using below command.
20+
21+
`dotnet tool install --add-source "https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json" --version 1.0.0-dev.20240919.3 --tool-path <installation path> APIViewJsonTool
22+
`
23+
24+
### Usage
25+
26+
Here are two examplea of how to use APIViewJsonUtility:
27+
28+
- Create APIView output text
29+
30+
`.\APIViewJsonUtility.exe --path <Path to JSON tree token file> --dumpApiText`
31+
32+
- Convert Token file to tree model from flat list JSON
33+
34+
`.\APIViewJsonUtility.exe --path <Path to flat list JSON token file> --convertToTree`

0 commit comments

Comments
 (0)