Zurück Komplexes Objekt in REST Web-API-Aufruf

Ich habe eine Web API-POST-Methode nimmt eine benutzerdefinierte komplexe Objekt MyObjectRequest als parameter und gibt ein benutzerdefiniertes Komplexes Objekt MyObjectResponse. Die MyObjectResponse Objekt hat benutzerdefinierte komplexe Objekt Token als Eigenschaft. 

public class MyObjectRequest
{
   public string AppName { get; set; }
   public string Username { get; set; }
   public string Password { get; set; }
   public string AppIdentifier { get; set; }
}

public class MyObjectResponse
{
   public bool Authenticated { get; set; }
   public Token AccessToken { get; set; }
}

public class Token
{
   public string Id { get; set; }
   public string ExpirationDate { get; set; }
}

Habe ich den Web-API-controller, wo, wenn der Benutzer eine HTTP-POST-Aufruf, möchte ich zu dem zurückkehren der MyObjectResponse.

public class MyCustomController : Controller
{
    public MyObjectResponse Post([FromBody] MyObjectRequest request)
    {
        //do my work here
    }
}

Ist das der richtige Weg, meine MyCustomController API-Signatur?

InformationsquelleAutor Michael Kniskern | 2014-05-27
  1. 13

    Was müssen Sie sicher arbeiten können. Ich Neige dazu, wickeln Sie die Objekte in der HttpResponseMessage wie unten:

    [HttpPost]
public HttpResponseMessage Post([FromBody] MyObjectRequest request)
{
    if (ModelState.IsValid) //and if you have any other checks
    {
        var myObjectResponse = new MyObjectResponse(); 
        //In your case, this will be result of some service method. Then...

        return Request.CreateResponse(HttpStatusCode.Created, myObjectResponse);
    }
    return Request.CreateResponse(HttpStatusCode.BadRequest);       
}

[HttpPut]
public HttpResponseMessage Update([FromBody] UserModel userModel)
{
    if (ModelState.IsValid)
    {
        var myObjectResponse = new MyObjectResponse();
        //In your case, this will be result of some service method. Then...
        return Request.CreateResponse(HttpStatusCode.Accepted);
    }
    return Request.CreateResponse(HttpStatusCode.BadRequest);
}

[HttpGet]
public HttpResponseMessage Get(int id)
{
    var myObjectResponse = GetObjectFromDb(id);
    //In your case, this will be result of some service method. Then...
    if(myObjectResponse == null)
        return Request.CreateResponse(HttpStatusCode.NotFound);

    return Request.CreateResponse(HttpStatusCode.OK, myObjectResponse);            
}

    Diese Weise kann der client schaut einfach auf dem status-code und entscheiden, was zu tun, mit der Antwort, ohne wirklich zu versuchen zu Deserialisieren es. Sie können mehr info auf HttpStatusCodes bei in diesem MSDN-Artikel.

    Haben Sie weitere Methoden wie ApiController.Ok im WebApi2. Für weitere Informationen, können Sie einen Blick auf diese ASP.NET WEB-API-übersicht Seite.

    InformationsquelleAutor Yogiraj
  2. 0

    Ja, das ist vollkommen in Ordnung, so wie eine api-Signatur

    • Danke. Würde diese Arbeit in einer iOS-und Android-Umgebung. Planen Sie auf dieser verbraucht von mobilen Anwendungen.
    • Es sein sollte. Der Vorteil der web-api ist, dass es content-negotiation basiert auf der content-type im header der Anforderung. Das bedeutet, dass Sie verlangen können, es als JSON -, XML-oder beliebige andere standard-format, die Sie benötigen auf der client-Seite.
    InformationsquelleAutor TGH
Schreibe einen Kommentar