从 API 方法返回 JSON

Question

我在这里使用 ASP.net Core web api (c#)

我有一个 JSON 字符串：

{
   "userId":321,   
   "account":"new  
   "fname":"Adam",
   "lname":"Silver" 
   "features":[
      {
         "available":true,
         "status":open,
         "admin":false        
      }
   ]
}

我想在我的 Angular 代码中测试这些数据，所以想将它硬编码到我的 API 中；然后我希望我的 API 将其返回。我发现很难的是如何退货。我应该把它作为一个字符串返回还是需要解析它？

我的 API 中有这个方法：

[HttpGet]        
public ActionResult<IEnumerable<string>> Get()
{
     return new string[] { "value1", "value2" };
}

我需要将它表示成字符串还是以某种方式解析它？

Answer 1

您的 JSON 无效。我们需要纠正它。 JSONLint 可以对此有所帮助。我拿走了你的 JSON 并纠正了语法错误，直到我得到这个：

{
   "userId": 321,   
   "account": "new",
   "fname": "Adam",
   "lname": "Silver",
   "features":[
      {
         "available": true,
         "status": "open",
         "admin": false        
      }
   ]
}

然后我需要生成一个 C# 类结构来表示这个 JSON。我可以手动创建它，但优秀的json2csharp.com 可以快速为我生成它。我将此 JSON 输入并收到以下类：

public class Feature
{
    public bool available { get; set; }
    public string status { get; set; }
    public bool admin { get; set; }
}

public class RootObject
{
    public int userId { get; set; }
    public string account { get; set; }
    public string fname { get; set; }
    public string lname { get; set; }
    public List<Feature> features { get; set; }
}

我将这些类定义放入我的应用程序中。然后我需要修改我的操作方法来创建这个 RootObject 类的实例（你应该更改名称以实际匹配它的用途）。

[HttpGet]        
public ActionResult<RootObject> Get()
{
    // Create an instance of our RootObject and set the properties
    var myRootObject = new RootObject();
    myRootObject.userId = 321;
    myRootObject.account = "new";
    myRootObject.fname = "Adam";
    myRootObject.lname = "Silver";
    myRootObject.features = new List<Feature>();

    // Create an instance of a feature and set its properties
    var feature = new Feature();
    feature.available = true;
    feature.status = "open";
    feature.admin = false;

    // Add the new feature to the features collection of our RootObject    
    myRootObject.features.Add(feature);

    // Return the instance of our RootObject
    // The framework will handle serializing it to JSON for us
    return myRootObject;
}

请注意，我更改了您方法的签名。我让它不再接受 IEnumerable ，因为不清楚你为什么要这样做。在检查了 Microsoft 的 documentation 后，我将其更改为返回 ActionResult。

Answer 2

您好，请为上述格式找到正确的 JSON 格式：

{
    "userId": 321,
    "account": "new",
    "fname": "Adam",
    "lname": "Silver",
    "features": [{
        "available": true,
        "status": "open",
        "admin": false
    }]
}

您可以在 Web API 中使用以下类来传递相应的数据

public class Feature
{
    public bool available { get; set; }
    public string status { get; set; }
    public bool admin { get; set; }
}

public class RootObject
{
    public int userId { get; set; }
    public string account { get; set; }
    public string fname { get; set; }
    public string lname { get; set; }
    public List<Feature> features { get; set; }
}

然后在最后，在返回数据时，通过将相应的类对象序列化为 JSON 格式，将相应的类对象转换为 JSON。

希望它能满足您的要求。

Answer 3

将 cmets 放入答案中： 如果您使用的是 ActionResult，我假设您使用的是 asp.net mvc。你想要的是 JsonResult。

    [HttpGet]
    public JsonResult Get()
    {
        return new JsonResult
        {
            Data = new
            {
                userId = 321,
                account = new
                {
                    fname = "Adam",
                    lname = "Silver",
                    features = new object[]{
                    new
                {
                    available = true,
                    status = "open",
                    admin = false
                }
                }
                }
            },
            JsonRequestBehavior = JsonRequestBehavior.AllowGet
        };
    }