ASP.NET MVC4 Web API - Control over formatting of returned JSON and what is included?

Question

I am creating my first ASP.NET MVC4 Web API. I have a database with 20 or so entities already created and hosted on Azure, and used Entity Framework to reverse engineer the database into POCO classes.

They ended up looking something like this:

public class Activity
{
    public Activity()
    {
        this.ActivityCategories = new List<ActivityCategory>();
        this.ActivityImages = new List<ActivityImage>();
        this.PerformedActivities = new List<PerformedActivity>();
        this.UserActivities = new List<UserActivity>();
    }

    public int ActivityID { get; set; }
    public string Name { get; set; }
    public string Description { get; set; }
    public Nullable<int> Thumbnail { get; set; }
    public virtual Image Image { get; set; }
    public virtual ICollection<ActivityCategory> ActivityCategories { get; set; }
    public virtual ICollection<ActivityImage> ActivityImages { get; set; }
    public virtual ICollection<PerformedActivity> PerformedActivities { get; set; }
    public virtual ICollection<UserActivity> UserActivities { get; set; }
}

Then, I created an ApiController extension class with an action like so:

    public IEnumerable<Activity> All()
    {
        return db.Activities.ToArray();
    }

And, as expected, it returned a very long JSON reply. The JSON reply included everything defined in the Activity class. But what if I don't want to include EVERYTHING? For instance, I don't want to return things like UserActivities, PerformedActivities, etc.

Basically I want my JSON to look something like:

[
    {
        "id":"32",
        "name":"this activity name",
        "description":"blah blah",
        "thumbnail":"http://mydomain.com/images/32/thumbnail.png",
        "images": [
            {
                "name":"this image",
                "url":"http://mydomain.com/images/32/1.png",
            },
            {
                "name":"cool image",
                "url":"http://mydomain.com/images/32/2.png",
            },
        ],
    },
    ...
]

(ignore any formatting errors in my JSON, just typed up the example really fast)

Notice, I don't want to necessarily use the same property names either. Is there an efficient way to massage my data into the format I want?

My first thought is to copy each activity into an array of structs that only include the properties I want. Is there a more elegant solution?

cuongle · Accepted Answer · 2014-02-22 00:51:31Z

4

DTO object would rescue you in this case, DTO will provide enough data for your consumer, so define DTO with which data need to be transfer thru Web API. In some cases, you can use your Model from your EF, but:

Normally, EF will generate dynamic proxy under the hood to support lazy loading and tracking changes. The issue you might get is serialization problem, because Web API will serialize proxies, not your POCO object.
Transferring too much needless data to consumer will make HTTP request kind of heavy and disclose the data leak.
Violate separation of concerns, when EF Model is domain entities, they do not take responsibility as data transfer object.

In your sample, you can define ActivityDto, and eliminate needless properties as you mentioned:

public class ActivityDto
{
    public string Name { get; set; }
    public string Description { get; set; }
    public Nullable<int> Thumbnail { get; set; }
    public virtual Image Image { get; set; }
}

public IEnumerable<Activity> All()
{
    return db.Activities.Select(a => new ActivityDto(){
        Name = a.Name,
        Description = a.Description,
        Thumbnail = a.Thumbnail
        // More properties if you need

    }).ToArray();
}

In case you want to look for a tool to map DTO to EF Model automatically, AutoMapper is here.

edited Feb 22, 2014 at 0:51

answered Sep 19, 2012 at 7:25

cuongle

75.5k30 gold badges155 silver badges212 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Danny Over a year ago

So I guess that sounds pretty similar to what I had in mind. I created a MyAPI.DTO namespace and defined all my DTOs there.

Rick Strahl Over a year ago

You don't necessarily need to create a DTO - you can just project into an anonymous type

cuongle Over a year ago

@RickStrahl: What if you get from POST data?

Ben · Accepted Answer · 2012-09-18 17:18:42Z

1

In MVC it's not really best practice to use a database entity as a model, instead I'd create a POCO (or even more complex object) as your ViewModel than you can then return that only contains the data that is needed by your view (or in this case API user). If you just want to manipulate the data returned, I'm not sure how to do that, but I know WebAPI uses newtonsoft's JSON.NET library to output JSON so you would look into the ways to manipulate that.

answered Sep 18, 2012 at 17:18

Ben

1,78616 silver badges33 bronze badges

1 Comment

Danny Over a year ago

Could you provide an example for creating a ViewModel or give more explanation? Like I said, first time at this...

Collectives™ on Stack Overflow

ASP.NET MVC4 Web API - Control over formatting of returned JSON and what is included?

2 Answers 2

3 Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related