Practical ASRNET. Web API. Badrinarayanan Lakshmiraghavan. Apress*

Transcription

1 Practical ASRNET Web API Badrinarayanan Lakshmiraghavan Apress*

2 Contents J About the Author About the Technical Reviewer Introduction xiii xv xvii Chapter 1: Building a Basic Web API Choosing ASP.NET Web API or WCF Exposing an In-Memory List over HTTP Choosing Configuration over Convention Playing by the Rules of HTTP Retrieving Resource(s) Creating a Resource with a Server-Generated Identifier Creating a Resource with a Client-Supplied Identifier Overwriting a Resource Updating a Resource Partially Updating (Patching) a Resource Deleting a Resource 24 Summary 25 Chapter 2: Debugging and Tracing Using Fiddler for Web Debugging Capturing Console App Traffic through Fiddler Capturing HTTPS Traffic in Fiddler Composing and Submitting Requests in Fiddler Using F12 Developer Tools in Internet Explorer Using Developer Tools in Chrome 37 vii

3 2.7 Enabling ASP.NET Web API Tracing Creating a Custom Trace Writer Tracing Entry and Exit Tracing from Your Code Tracing Request and Response Messages 51 Summary 53 Chapter 3: Media-Type Formatting CLR Objects Listing the Out-of-Box Media Formatters Understanding Conneg Requesting a Content Type through the Query String Requesting a Content Type through the Header Implementing a Custom Media Type Mapping Overriding Conneg and Returning JSON Piggybacking on Conneg Creating a Custom Media Formatter Extending an Out-of-Box Media Formatter Controlling Which Members Are Serialized Blacklisting Members Whitelistlng Members Controlling How Members Are Serialized Controlling Member Names Prettifying JSON Returning Only a Subset of Members 81 Summary 83 Chapter 4: Customizing Response Negotiating Character Encoding Supporting DBCS Character Encoding (Shift JIS) Negotiating Content Encoding (Compression) 90 viii

4 4.4 Negotiating Language Internationalizing the Messages to the User Internationalizing the Decimal Separators of Numbers Internationalizing the Dates 110 Summary 113 Chapter 5: Binding an HTTP Request into CLR Objects Reading the Raw HTTP Request Reading the HTTP Request into a CLR Type Binding the HTTP Request to Simple Types Binding the HTTP Request to Complex Types Binding the HTTP Request to a Collection Binding the Form Data Binding to FormDataCollection Binding to Custom Class Binding to a Simple Type Binding dd/mm/yyyy Dates Using TypeConverter Creating a Custom Value Provider Creating a Custom Model Binder Creating a Custom Parameter Binder Creating a Custom Media Formatter 152 Summary 155 Chapter 6: Validating Requests Validation Using Data Annotations Handling Validation Errors Extending an Out-of-the-Box Validation Attribute Creating Your Own Validation Attribute Implementing the IValidatableObject Interface 172 Summary 173 ix

5 Chapter 7: Managing Controller Dependencies Taking Dependency on the Entity Framework Inverting Entity Framework Dependencies Using the Repository Pattern Using the Generic Repository Pattern Mapping a Domain to Data Transfer Object (DTO) Injecting Dependencies Using StructureMap Unit-Testing the Controller 202 Summary 209 Chapter 8: Extending the Pipeline Creating a Message Handler Creating an Exception Filter Creating an Action Filter to Handle Concurrency Creating a Controller Selector for Versioning 225 Summary 229 Chapter 9: Hosting ASP.NET Web API Web Hosting ASP.NET Web API Self-Hosting ASP.NET Web API In-Memory Hosting ASP.NET Web API 248 Summary 253 Chapter 10: Securing ASP.NET Web API Implementing Direct Authentication Implementing Brokered Authentication Authorizing Requests 271 Summary 273 X

6 Chapter 11: Consuming ASP.NET Web API Calling a Web API from a Console Application Calling a Web API from a WPF Application Calling a Web API from JavaScript Summary 294 Chapter 12: Building a Performant Web API Creating Asynchronous Action Methods Pushing Real-time Updates to the Client Implementing Simple Web Caching 306 Summary 314 Index 315 xi