This sample demonstrates how to extend the WCF REST programming model to support new incoming request formats. The sample also includes an implementation of a formatter that can deserialize a request from an HTML form post into a .NET Framework type. In addition, the sample uses a T4 Template to return an HTML page, which provides the HTML form that users can post back to the WCF REST service.
Extending support for incoming request formats.
Integrating T4 templates.
This sample consists of two projects. One project is the HtmlFormProcessing library that includes a custom request formatter that can deserialize HTML form posts into .NET Framework types. The second project is a console application that extends the Basic Resource Service sample to use the custom request formatter of the HtmlFormProcessing library.
The custom formatter that can deserialize HTML form posts (HtmlFormRequestDispatchFormatter) accepts both .NET Framework types that can be converted from a string using the QueryStringConverter and types marked with DataContractAttribute that only have members that can be converted from a string using the QueryStringConverter.
The HtmlFormProcessing library project also includes an abstract base class,
RequestBodyDispatchFormatter, which can be used to create other custom request formatters. Deriving from the
RequestBodyDispatchFormatter allows a developer to focus on the request body deserialization logic, which allows the base class to map the URI template parameters to the operation’s method parameters. Also in the HtmlFormProcessing library project is the
HtmlFormProcessingBehavior class, which demonstrates how to derive from the WebHttpBehavior to replace the default request formatter with a custom request formatter.
This console application project extends the Basic Resource Service sample. The Basic Resource Service sample demonstrates how to expose a resource in a manner that uses the WCF REST programming model. In the Basic Resource Service sample, a customer collection resource is exposed such that customers in the collection can be created, retrieved, updated and deleted. The Basic Resource Service sample only uses the two natively supported incoming request formats, XML and JSON.
The console application in this Form Post sample utilizes the custom formatter in the HtmlFormProcessing library, which allows users to create customers by sending a request from an HTML form post using a browser. It also adds an operation that returns an HTML page, which includes the form to be posted back to the service. This HTML page is generated using a preprocessed T4 template, which consists of a .tt file and an auto-generated .cs file. The .tt file allows a developer to write a response in a template form that contains variables and control structures. For more information about T4, see Generating Artifacts By Using Text Templates.
To run the sample
Open the solution for the Form Post Sample. When launching Visual Studio 2012, you must run as an administrator to execute the sample successfully. Do this by right-clicking the Visual Studio 2012 icon and choosing "Run as Administrator" from the context menu.
Press CTRL+SHIFT+B to build the solution and then press CTRL+F5 to run the console application FormPost project.
The console window appears and provides the URI of the running service and the URI of the HTML help page for the running service.
As the sample runs, the client writes the status of the current activity, whether it be adding a customer, updating a customer, deleting a customer or getting a list of current customers from the service to the console window.
You are then prompted to browse to the URI of the customer form. Open a browser and browse to the given URI. Type in a name and address for the customer and click the Submit button.
Press any key for the console window to continue running the sample.
As the sample completes, notice that the customer you created using the browser is included in the final list of customers.
Press any key to terminate the sample.
The samples may already be installed on your machine. Check for the following (default) directory before continuing.
If this directory does not exist, go to Windows Communication Foundation (WCF) and Windows Workflow Foundation (WF) Samples for .NET Framework 4 to download all Windows Communication Foundation (WCF) and WF samples. This sample is located in the following directory.