[APIView] Generate API Report in JSON

[HarshaNalluru]

Description

This pull request introduces the generate_api_report tool, which generates a JSON report of the API documentation for a specified Rust package. The tool processes the JSON output from cargo +nightly rustdoc ... to remove unnecessary attributes and outputs a cleaned-up version of the JSON.

Changes

• Added generate_api_report tool in the eng/tools/ directory.
  • Main Functionality: Implemented in src/main.rs to handle the command-line interface and processing logic.
  • Data Models: Defined in src/models.rs to represent the minimal structure of the JSON data from rustdoc.
  • Dependencies: Updated Cargo.toml to include dependencies on toml, serde and serde_json for JSON parsing and serialization.
• Added README.md explaining the usage and functionality of the tool.

Usage

To run the tool, navigate to the root of the azure-sdk-for-rust repository and use the following command:

cargo run --manifest-path eng/tools/generate_api_report/Cargo.toml -- --package <package_name>

This generates cleaned-up JSON to a new file package_name/review/package_name.rust.json.

Example

For example, to generate the report for a package named azure_template, run:

cargo run --manifest-path eng/tools/generate_api_report/Cargo.toml -- --package azure_template

Related work

The output from this tool is fed as the input to the rust-api-parser at Azure/azure-sdk-tools#9592

[heaths]

If this is working well enough, let's merge this and start a new PR. You don't want topic branches open so long when their target branches are changing as significantly as main...and it's about to get a whole lot worse.

[RickWinter]

Looks good, lets get this in.