CSharp/C#, processing REST requests in C#

microsoft.public.dotnet.languages.csharp - General discussion regarding the C# .NET programming language. including best practices on developing with C# in VS, documentation, setup, and samples.


CSharp/C# >> processing REST requests in C#

by mmc » Thu, 04 Sep 2008 16:23:38 GMT

Hi all,
I've been using C# for a long time, but am somewhat new to REST, and
have what I'm sure are real newbie questions:

I want to develop a RESTful Web Service API that will be able to
handle requests of the form

http://mydomain.com/widgets/france --(returns all widgets available
in france)
http://mydomain.com/widget/1234 -- (returns data about widget # 1234)
http://mydomain.com/widget/1234/costInDollars --(returns the price of
widget #1234 in $)
http://mydomain.com/widget?id=1235&name=NewWidget&costUS=25.5&country=Spain
--(creates a new widget with an id of 1235, a name of NewWidget, a
costInDollars of $25.50, and an available-in-country of Spain.

My questions:
1) are these "RESTful calls"? (I'm pretty sure the first 3 are, but
is the last one a reasonable syntax for "add widget"?
2) On the server side, does the HTTP handler simply parse the URL to
retrieve the object type, ID, etc. (and retrieve the QueryString
params normally), or is there a streamlined way to break about the
URL?

Thanks in advance for any help!

Top

CSharp/C# >> processing REST requests in C#

by Pavel Minaev » Thu, 04 Sep 2008 18:17:24 GMT



It's not. The URL you provided clearly indicates that it will be an HTTP GET
request. According to REST principles as applicable to HTTP, creating new
objects is represented by HTTP POST. So, HTTP GET for
http://mydomain.com/widgets/ returns the list of all widgets , and HTTP POST
to http://mydomain.com/widgets/ adds a new widget.

Also, you shouldn't vary singular/plural. So it's "widgets/1234", and not
"widget/1234" (this is to maintain the proper URL hierarchy - a specific
widget is a child of the entire collection of widgets).


To begin with, in .NET 3.5 SP1, there's ADO.NET Data Services, which
(almost) seamlessly provides RESTful services on top of anything that
implements IQueryable<T> and IUpdatable. If you're a conventional REST layer
on top of your data model, it may well be just what you need (and if your
data storage is MSSQL, then you can use Entity Framework to map it to EDM,
which Data Services can consume, and save even more time).

Otherwise, why not use ASP.NET? You'll have to ignore all the Web Forms
stuff, of course, but you'll get to use some handy classes such as
HttpRequest and its Form property, which will parse those name/value pairs
in GET/POST/PUT requests for you.
Top

CSharp/C# >> processing REST requests in C#

by mmc » Thu, 04 Sep 2008 20:22:55 GMT

Thanks very much, Pavel. That's exactly the kind of feedback I was
hoping for.

Regarding the server-side stuff, I plan to use ASP.NET, and will
explore the .NET 3.5 ADO.NET Data Services stuff you describe.
Happily, we're also using SQL Server, so I'll also look into the
Entity Framework stuff.

I still don't think I'm 100% clear on how to decompose the
"mydomain.com/widgets/1234/costInDollars" type URL into its composite
parts (e.g the widget ID, etc.), but maybe there are HttpRequest
methods and/or other mechanisms to do that for me.

Thanks again!
Top

CSharp/C# >> processing REST requests in C#

by Pavel Minaev » Thu, 04 Sep 2008 20:49:30 GMT


Yes, you can use the same class that Data Services uses - it's called
UriTemplate, introduced in 3.5 (plain one, pre-SP1). You can define a
template like this (MSDN example):

weather/{state}/{city}?forecast={day}

and then you use UriTemplate.Match to match this template against the URI,
and retrieve the matched values from the returned UriTemplateMatch object.

You can look at the complete example here:
http://msdn.microsoft.com/en-us/library/system.uritemplate.match.aspx

By the way, it seems that WCF in 3.5+ allows very seamless creation of
RESTful web services based on those URI templates. It would look like this:
[DataContract(Namespace="")]
public class Customer
{
[DataMember]
public string ID { get; set; }
[DataMember]
public string Name { get; set; }
} [ServiceContract]
public interface IService
{
[OperationContract]
[WebGet(UriTemplate="customers/{id}")]
Customer GetCustomer(string id);

[OperationContract]
[WebInvoke(UriTemplate="customers")]
Customer PostCustomer(Customer c);
}Here's more on this:
http://blogs.msdn.com/kaevans/archive/2008/04/03/creating-restful-services-using-wcf.aspx
Top

CSharp/C# >> processing REST requests in C#

by mmc » Thu, 04 Sep 2008 23:27:47 GMT

Thanks again, Pavel. I'm not sure 3.5 is an option for me, but it
might be. If so, it sounds like UriTemplate is just the ticket. I'll
also check out the blog.

I appreciate the on-target and succinct help!
Top
Similar Threads

1. request: processing instructions removed using http request. 

hi,

when sending out a xmldocument with a processing instruction to a client 
browser, in this case its an xslt instruction.  the web service engine 
ignores the transmission of the processing instruction.

how can i submit the xmldocument WITH the processing instruction still 
attached to the document being sent to the client browser?

regards,
michael

2. Listening to HTTP requests from a process - CSharp/C#

3. Listen to another console process's input request? 

Hi all,

I know how to start a process and use my own streamwriter
to provide input. But now the question is, how do I know
when a process/console program needs input?

So for example, say there's a console program called
"a.exe" that first outputs some messages and then prompts
for a number for further calculation. I know how to use the
proc.StandardOutput to get the message, but I have no idea
when it prompts, and furthermore, control doesn't seem to
flow back to my program when a.exe is prompting.

Just a note that a.exe is only an example and I need to be
able to handle any console programs. You can think of it
more like my version of cmd.exe

Any ideas are appreciated. Thanks.

4. HTTP In Process Request using com+

5. FEATURE REQUEST: C# shared .cs files in project 

Hi,

  I have made an assembly file but i want to share 
some .cs files and not have to ship the dll assemblies.

  I want to be able to point to this .cs file in a project 
that is in a different directory, but it always copies 
the .cs file locally. Can i override this?  I dont want to 
have to maintain  2 copies of one file.

Thanks.

6. occasional "The requested name is valid, but no data of the requested type was found" - CSharp/C#

7. Accessing the HTTP Request sent to legacy ASP page in .Net C# COM 

Hi,

I have some legacy ASP web applications that use an unmanaged COM
component to connect to a third party application. The third part
application has moved to the managed code in the current release with
backward compatibility with the unmanaged code.
In the future releases, the vendor is going to drop backward
compatibility and as a result of that all our legacy ASP applications
will break.

What I am trying to do is:
- Create a managed COM component using the InteropServices that wraps
the new managed components using C# that provides the same interfaces
like the vendors old unmanaged one.
- Use this component in the ASP application instead of the old one to
retrieve the necessary information from the new system and pass it back
to the ASP application.

Unfortunately, this requires accessing the HTTP request sent to the ASP
application from within the .Net component. When I tried to use the
.Net System.Web.HttpContext.Current.Request it gave me an exception
that "Object reference not set to an instance of an object".

My questions are:
- When using the managed COM in the legacy ASP, can I instantiate the
.Net http request within the same context of the unmanaged client?
- How can I construct a .Net http request from the ASP Request object?

Thanks,

Omar

8. Ping request UDP C# PocketPC