Create a View against an API controller?

Question

I need to create a website where some of it's pages should be accessible from external clients via an API, but I still want to make regular MVC Razor views to retrieve, display and manipulate the same data.

What's the best way to achieve this?

Update

What the API will have to expose is just data manipulation.

For the web pages, I still want to benefit from the razor chtml views, I prefer not polluting my views with redundant jQ or JS nor data- attributes that consume the data.

StriplingWarrior · Accepted Answer · 2014-05-08T23:28:06.597

1

Just create an MVC project with the pages you want, and then create ApiControllers (from the Web API framework) to serve as RESTful endpoints. You can program your views to retrieve data from the API actions as JSON objects, and consume them with javascript. Other people can hit the same API actions and use the data in some other way.

If you want to start with a WebApi, and build basic views based on the same data that someone else could access via that API, you could inject your WebApi controllers into your normal MVC controllers, and invoke their methods to get the data that you need to build your ViewModels. This should work all right as long as your API controllers don't need to do anything "outside the box" like inspecting the Request object directly.

A more robust method would be to create a "Manager" layer that handles all the business logic of your application, and then have your ApiControllers be nothing but thin wrappers around calls to their respective Manager classes. This would add a little maintenance cost, but it would adhere to the Single Responsibility Principle a little better.

edited May 08 '14 at 23:28

answered May 08 '14 at 04:07

StriplingWarrior

151,543
27
246
315

That's exactly my question, whether you can benefit from both worlds, web api and MVC views (not consumed with js etc.). I like to keep my views as poor and clean as possible. – Shimmy Weitzhandler May 08 '14 at 05:00
1

@Shimmy: Am I understanding that you don't want to build a rich client interface that uses AJAX and such? You just want to have a WebApi, and build basic views based on the same data that someone else could access via that API? Conceivably, you could inject your WebApi controllers into your normal MVC controllers, and invoke their methods to get the data that you need to build your ViewModels. – StriplingWarrior May 08 '14 at 15:31
@StripingWarrior, I read your comment. that's what I'm gonna do! That's the answer, please update your post. – Shimmy Weitzhandler May 08 '14 at 22:57

score 1 · Answer 2 · answered May 08 '14 at 04:09

The easiet way is to use just MVC.

You can also combine MVC + WebAPI in one site.

The reasons to go with the first option is simplicity, and learning maintaining one framework and one set of abstractions.

However if you have any of the following requirements, adding Web API becomes interesting: 1. You want to do content negotiation for response types (say XML vs. Json for the same action). 2. You want to support CORS 3. You want a help page for your API. 4. You want to structure your Url space for your API with rest and resource centric approach (basically GET /resource rather than /resource/GetData). 5. Easier to unit test controllers and actions.

Both frameworks are built by the same team, they both support attribute routing and many similar concepts, and both work well together with one another. I've seen folks take both approaches successfully. Also note that visual studio has templates that combines both of them from the get go.

Create a View against an API controller?

2 Answers2