Building json response

Question

Я работаю над самообслуживанием rest api, используемым для контроля состояния нескольких серверов.

мне было поручено, что, когда все работает правильно, я должен вернуться только

{"response":"ok"} 

Но, когда есть ошибка на запрашиваемом сервере или серверах, я должен вернуться

{ "response" : [ {"agent":"<server>:<port>","port":"<port>" ,"Error":"<Description of the error>"} ] } 

I подумывал о создании вспомогательного класса для создания объекта по этой схеме и возвращения их по остальной части api

public class HelperErrorResponseClass 
{ 
    public string agent { get; set; } 
    public string port { get; set; } 
    public string Error { get; set; } 
} 

Это не проблема, проблема в том, как бороться, когда все в порядке. У меня есть этот ответ Api вспомогательный класс

public class Response 
{ 
    public string response { get; set; } 
} 

Но я вижу, что мне нужно изменить свойство ответа на List<HelperErrorResponseClass> для того, чтобы отправить ошибочный ответ. Считаете ли вы, что если я строю объект List<HelperErrorResponseClass> с Json.Net, он будет возвращен в желаемом формате?

Редактировать: Забыл добавить это, I-m используя веб-Api для создания службы отдыха.

UDPATE:

После дальнейших исследований, я нашел способ решить эту проблему.

После this post, я был в состоянии переписать вспомогательные классы как этот

[DataContract] 
[KnownType(typeof(List<HelperErrorResponseClass>))] 
public class Response 
{ 
    [DataMember] 
    public object response { get; set; } 
} 

[DataContract] 
public class HelperErrorResponseClass 
{ 
    [DataMember(EmitDefaultValue = false)] 
    public string agent { get; set; } 
    [DataMember(EmitDefaultValue = false)] 
    public string port { get; set; } 
    [DataMember(EmitDefaultValue = false)] 
    public string error { get; set; } 
} 

Эту работу, чтобы выполнить мои и нуждается мой клиент ... для одной маленькой вещи, за исключением. Когда я получаю результат из списка, и учитывая, что я добавил KnownTypes директивы, мой ответ сейчас это

{"response":[{"__type":"HelperErrorResponseClass:#AppCommonLib","Error":"ERROR","InstanceId":"<InstanceId> : <Port>","PortType":"<PortType>"},{"__type":"HelperErrorResponseClass:#AppCommonLib","Error":"ERROR","InstanceId":"<InstanceId> : <Port>","PortType":"<PortType>"}]} 

Любой идея, как избавиться от этой __type имущества ответа? что он должен быть явным, чтобы возвращать объявленные свойства класса-помощника?

Answer 1

Простейший способ справиться с этим - установить тип возвращаемого значения для функции обработки в строку, затем вы можете проверить наличие ошибок и сделать что-то вроде;

//pseudo code to give an idea 
if (errorsList.Count() > 0) 
{ 
    return JsonConvert.SerializeObject(errorsList); 
} 
else 
{ 
    return JsonConvert.SerializeObject(new Response("ok")); 
} 

Теперь это сказано ... Если люди, не соблюдающие требования, совсем не гибкие, вы должны просто переделать дизайн. Как насчет того, чтобы просто вернуть массив ошибок, и человек, вызывающий API, может сделать вывод, что если длина равна 0, тогда все работает нормально. Кажется довольно прямолинейным, не так ли? Вы также можете просто поместить все свойства на один объект, и эти поля просто вернутся как пустые или пустые строки. Или вы можете изменить настройки сериализатора, чтобы исключить их, если они не имеют значения.

Answer 2

Держите вещи простыми и используйте анонимный тип.

if (condition) 
{ 
    return JsonConvert.SerializeObject(new { response = new { agent = "x", port = "y", error = "z" }}); 
} 
else 
{ 
    return JsonConvert.SerializeObject(new { response = "ok"}); 
} 

Подробнее:

https://msdn.microsoft.com/en-us/library/bb397696.aspx

Answer 3

лично я не думаю, что вам нужен Response класс, тем более, что она имеет object типа. ИМХО, вы слишком усложнили очень простую проблему, которая у вас есть. Это не только __type, но и другая информация, подобная HelperErrorResponseClass:#AppCommonLib, которая не должна быть там.

Другой вопрос, который у вас есть, является неправильным названием класса HelperErrorResponseClass. Это не вспомогательный класс. Это стандартный класс объектов данных.

Класс-помощник - класс, заполненный статическими методами. Он обычно используется для выделения «полезного» алгоритма.

Это, как я хотел бы сделать это:

1. Я бы избавиться от Response класса.
2. Я бы использовал ваш оригинальный простой класс HelperErrorResponseClass, но переименовал его в нечто более содержательное, как ErrorDetails.
3. я возвращал ответ, как это:

.

if (errorsList.Count() > 0) { 
    return JsonConvert.SerializeObject(new { response = errorsList}); 
} 
else { 
    return JsonConvert.SerializeObject(new { response = "ok"}); 
} 

Однако, если вы действительно хотите придерживаться своего обновленного решения, легкого способ избавиться от __type просто извлекая его из конечной сериализованной строки:

if (errorsList.Count() > 0) { 
    string r = JsonConvert.SerializeObject(new { response = errorsList}); 
    return r.Replace("__type", ""); 
} 
else { 
    return JsonConvert.SerializeObject(new { response = "ok"}); 
}