From 8b7d1c8e3870234e4e8bf6ba2557260e53005255 Mon Sep 17 00:00:00 2001 From: Maggie Kimani Date: Wed, 3 May 2023 13:22:35 +0300 Subject: [PATCH 1/3] Update README.md with guidelines on using workbench tool --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 0190e572d..baf262999 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ |--|--| |Models and Writers|[![nuget](https://img.shields.io/nuget/v/Microsoft.OpenApi.svg)](https://www.nuget.org/packages/Microsoft.OpenApi/) | |Readers | [![nuget](https://img.shields.io/nuget/v/Microsoft.OpenApi.Readers.svg)](https://www.nuget.org/packages/Microsoft.OpenApi.Readers/) | +|Hidi|[![nuget](https://img.shields.io/nuget/v/Microsoft.OpenApi.Hidi.svg)](https://www.nuget.org/packages/Microsoft.OpenApi.Hidi/) The **OpenAPI.NET** SDK contains a useful object model for OpenAPI documents in .NET along with common serializers to extract raw OpenAPI JSON and YAML documents from the model. @@ -90,6 +91,28 @@ var outputString = openApiDocument.Serialize(OpenApiSpecVersion.OpenApi2_0, Open ``` +# Validating/Testing OpenApi descriptions +In order to test the validity of an OpenApi document, we avail the following tools: +- [Microsoft.OpenApi.Hidi](https://www.nuget.org/packages/Microsoft.OpenApi.Hidi) + + A commandline tool for validating and transforming OpenApi descriptions. [Installation guidelines and documentation](https://github.com/microsoft/OpenAPI.NET/blob/vnext/src/Microsoft.OpenApi.Hidi/readme.md) + +- Microsoft.OpenApi.Workbench + + A workbench tool consisting of a GUI where you can test and convert OpenApi descriptions in both Json and Yaml from v2-->v3 and vice versa. + + #### Installation guidelines: + 1. Clone the repo locally by running this command: + `git clone https://github.com/microsoft/OpenAPI.NET.git` + 2. Open the solution file `(.sln)` in the root of the project with Visual Studio + 3. Navigate to the `src/Microsoft.OpenApi.Workbench` directory and set it as the startup project + 4. Run the project and you'll see a GUI pop up resembling the one below: + + + + + 5. Copy paste your OpenApi descriptions or paste the path to the descriptions file and click on `convert` to render the results. + # Build Status |**master**| From f80d52e599d3e713a6f08b23ba53d85560abc8b6 Mon Sep 17 00:00:00 2001 From: Maggie Kimani Date: Wed, 3 May 2023 15:44:25 +0300 Subject: [PATCH 2/3] Update README.md Co-authored-by: Irvine Sunday <40403681+irvinesunday@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index baf262999..07f4553c9 100644 --- a/README.md +++ b/README.md @@ -111,7 +111,7 @@ In order to test the validity of an OpenApi document, we avail the following too - 5. Copy paste your OpenApi descriptions or paste the path to the descriptions file and click on `convert` to render the results. + 5. Copy and paste your OpenApi descriptions in the **Input Content** window or paste the path to the descriptions file in the **Input File** textbox and click on `convert` to render the results. # Build Status From faf29de50d861f33c297e1f78229d454b3554bca Mon Sep 17 00:00:00 2001 From: Maggie Kimani Date: Tue, 9 May 2023 15:02:49 +0300 Subject: [PATCH 3/3] Clean up Readme file --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 07f4553c9..60cc5e2f7 100644 --- a/README.md +++ b/README.md @@ -91,15 +91,15 @@ var outputString = openApiDocument.Serialize(OpenApiSpecVersion.OpenApi2_0, Open ``` -# Validating/Testing OpenApi descriptions +# Validating/Testing OpenAPI descriptions In order to test the validity of an OpenApi document, we avail the following tools: - [Microsoft.OpenApi.Hidi](https://www.nuget.org/packages/Microsoft.OpenApi.Hidi) - A commandline tool for validating and transforming OpenApi descriptions. [Installation guidelines and documentation](https://github.com/microsoft/OpenAPI.NET/blob/vnext/src/Microsoft.OpenApi.Hidi/readme.md) + A commandline tool for validating and transforming OpenAPI descriptions. [Installation guidelines and documentation](https://github.com/microsoft/OpenAPI.NET/blob/vnext/src/Microsoft.OpenApi.Hidi/readme.md) - Microsoft.OpenApi.Workbench - A workbench tool consisting of a GUI where you can test and convert OpenApi descriptions in both Json and Yaml from v2-->v3 and vice versa. + A workbench tool consisting of a GUI where you can test and convert OpenAPI descriptions in both JSON and YAML from v2-->v3 and vice versa. #### Installation guidelines: 1. Clone the repo locally by running this command: @@ -111,7 +111,7 @@ In order to test the validity of an OpenApi document, we avail the following too - 5. Copy and paste your OpenApi descriptions in the **Input Content** window or paste the path to the descriptions file in the **Input File** textbox and click on `convert` to render the results. + 5. Copy and paste your OpenAPI descriptions in the **Input Content** window or paste the path to the descriptions file in the **Input File** textbox and click on `Convert` to render the results. # Build Status