Skip to content

ADD readme for APIViewJSON Utility #9270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
praveenkuttappan merged 2 commits into from
Oct 30, 2024
Merged

ADD readme for APIViewJSON Utility #9270

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb68c96
ADD readme for APIViewJSON Utility
praveenkuttappan Oct 29, 2024
9c81545
Update src/dotnet/APIView/APIViewJsonUtility/README.md
praveenkuttappan Oct 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions src/dotnet/APIView/APIViewJsonUtility/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# APIViewJsonUtility

### Overview

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.

### Features

- **Create API view output from JSON token**: Parse JSON token file to create the API review output text.
- **Convert to tree token model**: Convert an old flat list tree token JSON file to new tree style JSON token file.


### Prerequisites

- .NET SDK (version 8.0 or later)

### Installation

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.

`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
Copy link
Member

@maririos maririos Oct 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would it be better to just say <version> instead of us hardcoding a version here? I wonder if someone is not paying attention, they will just copy the command and might not get the latest version

`

### Usage

Here are two examplea of how to use APIViewJsonUtility:
Copy link
Member

@maririos maririos Oct 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

examples


- Create APIView output text

`.\APIViewJsonUtility.exe --path <Path to JSON tree token file> --dumpApiText`

- Convert Token file to tree model from flat list JSON

`.\APIViewJsonUtility.exe --path <Path to flat list JSON token file> --convertToTree`