yaml 或 json 格式的 OpenAPI 规范并解析为 c#

Question

如何采用 yaml 或 json 格式的大型 OpenAPI 规范并将其展平以在 C# 中生成摘要、标记、路径、httpMethod？

假设使用 JObject SelectTokens 但我无法弄清楚语法。

string json = File.ReadAllText ("spec.json");
JObject array = JObject.Parse(json);
array.SelectTokens("paths").Dump();

这是 json 规格示例

{
    "paths": {
        "/entities/{id}": {
            "get": {

                "summary": "Get Entity",

                "tags": [
                    "Things"
                ]
            },
            "put": {

                "summary": "Update Entity",

                "tags": [
                    "Things"
                ]
            }
        },
        "/otherEntities/{id}": {
            "get": {

                "summary": "Get Other",

                "tags": [
                    "Others"
                ]
            },
            "put": {

                "summary": "Update Other",

                "tags": [
                    "Others"
                ]
            }
        }
    }
}

我想要：

"Get Entity", "Things", "/entities/{id}", "get"
"Update Entity", "Things", "/entities/{id}", "put"
"Get Other", "Others", "/otherEntities/{id}", "get"
"Update Other", "Others", "/otherEntities/{id}", "put"

Answer 1

1. 迭代paths 。

   1.1。 将JObject转换为paths JObject 的Dictionary 。

2. 从1.1迭代为KeyValuePair 。

   2.1。 获取密钥作为path 。

   2.1。 将字典的值转换为methodKvp 。

3. 从2.2迭代为KeyValuePair 。

   3.1。 获取 key 作为method 。

   3.2. 从令牌“摘要”中获取summary 。

   3.3. 从标记“标签”中获取具有数组第一个值的标签。

   3.4. 将提取的值添加到列表中。

using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using System.Collections.Generic;
using System.Linq;

List<List<string>> result = new ();

foreach (JObject pathObj in array.SelectTokens("paths").AsJEnumerable())
{           
    Dictionary<string, JObject> pathDict = pathObj.ToObject<Dictionary<string, JObject>>(); 

    foreach (KeyValuePair<string, JObject> pathKvp in pathDict)
    {
        var path = pathKvp.Key;
        var methodDict = pathKvp.Value.ToObject<Dictionary<string, JObject>>();

        foreach (KeyValuePair<string, JObject> methodKvp in methodDict)
        {
            string method = methodKvp.Key;
            string summary = (string)methodKvp.Value.SelectToken("summary");
            string tag = (string)methodKvp.Value.SelectToken("tags").AsEnumerable().First();

            result.Add(new List<string> { summary, tag, path, method });
        }
    }       
}

样品 .NET 小提琴