Developing RESTful Services in .NET
Download as PPTX, PDF1 like692 views
The document provides a comprehensive guide on creating RESTful services in .NET, comparing different architectures like ROA and WOA while detailing the setup of Visual Studio, WCF, and ASP.NET. It includes extensive demos for implementing CRUD operations in Web Forms, MVC, and WCF REST services, alongside code snippets and troubleshooting tips. The conclusion emphasizes MVC's advantages over Web Forms and highlights WCF Data Services for secure and efficient data handling.
![Change DisplayGames to cater for single game option (Ctrl+7)if (request.QueryString["id"] != null){Guid pk = Guid.Parse(request.QueryString["id"]); response = (from g in Database.Instance.Games where g.PK == pk select g).ToList();}else{ response = Database.Instance.Games.ToList(); }Build -> Fiddler -> Request Builder -> GET: http://localhost:4000/Games.aspx -> Execute](https://image.slidesharecdn.com/restfulservices-110110032610-phpapp01/85/Developing-RESTful-Services-in-NET-21-320.jpg)
Developing RESTful Services in .NET
- 2. Look at creating RESTful Services using .NETNOT coveringDesign Patterns Best Practises*Overture
- 3. RESTAcronym? Representational State Transfer Source?Came about in 2000 doctoral dissertation of Roy Fielding
- 4. What is it?ROA – Resource Orientated ArchitectureWOA – Web Orientated ArchitectureThanks Gartner for another TLA It is a styleNOT APIInterfaceOfficial StandardA drop in replacement for SOAP
- 5. SetupVisual Studio - load restful service base
- 6. Make sure WCF REST template is installed
- 7. Fiddler – make sure capture traffic is off
- 8. Make sure JSON addon is installed
- 9. Tools -> Fiddler Options -> Enable IPv6 must be disabled
- 10. Rule 18Demo 1 – ASP.NET Web FormsAdd new ASP.NET Empty Web Application project - Name WebForms
- 11. Right click web project -> properties -> web -> specific port: 4000
- 12. Add Reference to BlackBox
- 13. Add new item web form – named games.aspx
- 14. Switch to code view and remove page_load method
- 15. Add render override (Ctrl+0)protected override void Render(HtmlTextWriter writer) { }Add Database Connection string (Ctrl+1)Database.ConnectionString = @"data source=C:\Users\Robert MacLean\Desktop\RESTful\WebForms\bin\superstore.sqlite";Add Response.Clear(); (Ctrl+2)
- 16. Add Request.HttpMethod switch (Ctrl+3)switch (Request.HttpMethod.ToUpperInvariant()){ case "POST": { break; } case "GET": { break; } case "PUT": { break; } case "DELETE": { break; }}Add DisplayGames method signature (Ctrl+4)private void DisplayGames(HttpRequest request) { }
- 17. Demo 1 continued.Add code to get and return all games (Ctrl+5)dynamic response;response = Database.Instance.Games.ToList();Response.ContentType = "application/json";Response.Write(JsonMagic.ConvertToJson(response));Response.StatusCode = 200;Add DisplayGames(Request); to GET case – (Ctrl+6)
- 18. RUN -> Show error in browser
- 19. Fiddler -> Request Builder -> GET: http://localhost:4000/Games.aspx -> Execute
- 20. Tour inspector
- 21. Change DisplayGames to cater for single game option (Ctrl+7)if (request.QueryString["id"] != null){Guid pk = Guid.Parse(request.QueryString["id"]); response = (from g in Database.Instance.Games where g.PK == pk select g).ToList();}else{ response = Database.Instance.Games.ToList(); }Build -> Fiddler -> Request Builder -> GET: http://localhost:4000/Games.aspx -> Execute
- 22. Fiddler -> Request Builder -> GET: http://localhost:4000/Games.aspx?id=11a78864-1f71-4010-b2f1-1735dfbf6bef -> Execute
- 23. Change from return .ToList() for one item to .Single();
- 24. Fiddler -> Request Builder -> GET: http://localhost:4000/Games.aspx?id=11a78864-1f71-4010-b2f1-1735dfbf6bef -> Execute -> Note difference in array
- 25. Repeat with http://localhost:4000/Games.aspx?id=oopsDemo 1 continuedWrap single response in try/catch (Ctrl+8)try { Guid pk = Guid.Parse(request.QueryString["id"]); response = (from g in Database.Instance.Games where g.PK == pk select g).Single();}catch{Response.StatusCode = 404; return;}Fiddler -> Request Builder -> GET: http://localhost:4000/Games.aspx?id=opps -> Execute -> Note 404 response
- 26. Add Create, update and delete methods – (Ctrl+9)private void CreateNewGame(HttpRequest request){ Game game = JsonMagic.ConvertFromJson<Game>(request.Headers["game"]);Database.Instance.InsertGame(game);Response.StatusCode = 201;}private void UpdateGame(HttpRequest request){ Game game = JsonMagic.ConvertFromJson<Game>(request.Headers["game"]);Database.Update(game);Response.StatusCode = 204;}private void DeleteGame(HttpRequest request){ Game game = JsonMagic.ConvertFromJson<Game>(request.Headers["game"]);Database.Delete(game);Response.StatusCode = 204;}
- 27. Demo 1 ContinuedUpdate switch to call relevant methods (Alt+0)case "POST":{CreateNewGame(Request); break;}case "GET":{DisplayGames(Request); break;}case "PUT":{UpdateGame(Request); break;}case "DELETE":{DeleteGame(Request); break;}Build -> Fiddler -> POST: http://localhost:4000/Games.aspx
- 28. Add new game header (Alt+1):
- 30. Execute -> Note 201 response
- 31. Fiddler -> GET: http://localhost:4000/Games.aspx -> Execute -> Note the new one in the list
- 32. Fiddler -> PUT: http://localhost:4000/Games.aspx -> Change the game header, for example the title -> Execute -> Note the 204 response
- 33. Fiddler -> GET: http://localhost:4000/Games.aspx -> Execute -> Note the update
- 34. Fiddler -> DELETE: http://localhost:4000/Games.aspx-> Execute -> Note the 204 response
- 35. Fiddler -> GET: http://localhost:4000/Games.aspx -> Execute -> Note the item is gone!Demo 2 – MVCAdd -> New ASP.NET MVC 2 Empty project -> Name: MVC
- 36. Project Properties -> Web -> Specific Port: 4010
- 37. Add Reference to BlackBox
- 38. Open Global.asax and in the start method and add (Alt+2): Database.ConnectionString = @"data source=C:\Users\Robert MacLean\Desktop\RESTful\MVC\bin\superstore.sqlite";
- 39. Add new controller. Name -> GamesController. -> Click Add
- 40. Add code to return games in Index method (Alt+3)dynamic response;response = Database.Instance.Games.ToList();return Json(response);F5 -> Go to http://localhost:4010/Games -> Error
- 41. Change the return to (Alt+4)
- 43. F5 -> Go to http://localhost:4010/Games -> It tries to download
- 44. Fiddler -> Request Builder -> GET: F5 -> Go to http://localhost:4010/Games
- 45. Change the Index method to support a single item (Alt+5)public ActionResult Index(Guid? id){ dynamic response; if (!id.HasValue) { response = Database.Instance.Games.ToList(); } else { try { response = (from g in Database.Instance.Games where g.PK == id.Value select g).Single(); } catch { Response.StatusCode = 404; return new EmptyResult(); } } return Json(response, JsonRequestBehavior.AllowGet);}
- 46. Demo 2 continuedAdd the create, update and delete methods (Alt+6)public ActionResult Create(){ Game game = JsonMagic.ConvertFromJson<Game>(Request.Headers["game"]);Database.Instance.InsertGame(game);Response.StatusCode = 201; return new EmptyResult();}public ActionResult Edit(){ Game game = JsonMagic.ConvertFromJson<Game>(Request.Headers["game"]);Database.Update(game);Response.StatusCode = 204; return new EmptyResult();}public ActionResult Delete(){ Game game = JsonMagic.ConvertFromJson<Game>(Request.Headers["game"]);Database.Update(game);Response.StatusCode = 204; return new EmptyResult();}Build -> Fiddler -> GET: http://localhost:4010/Games/Create add header from (Alt+1)
- 47. Fiddler -> GET: http://localhost:4010/Games/Delete add header from (Alt+1)
- 48. Add the HttpPost/HttpPut/HttpDelete & ActionName attributes to methods[HttpPost, ActionName("Index")][HttpPut, ActionName("Index")][HttpDelete, ActionName("Index")]Build -> Fiddler -> POST: http://localhost:4010/Games add header from (Alt+1)
- 49. Fiddler -> GET: http://localhost:4010/Games
- 50. Fiddler -> DELETE: http://localhost:4010/Games add header from (Alt+1)Demo 3 – WCF Data ServiceAdd new empty webform project -> Name WCFDataService
- 51. Project properties -> Web -> Specific Port -> 4020
- 53. Add new item -> WCF Data Service -> Name: Games.svc
- 54. Set Dataservice<T> to be DataService<EDMDatabase>
- 55. Add CreateDataSourceMethod (Alt+7):protected override EDMDatabase CreateDataSource(){EDMDatabase.ConnectionString = @"data source=C:\Users\Robert MacLean\Desktop\RESTful\MVC\bin\superstore.sqlite"; return EDMDatabase.Instance;}Set EntityAccessRule to config.SetEntitySetAccessRule("*", EntitySetRights.All);
- 56. Run -> Browse to http://localhost:4020/Games.svc/XboxGames
- 57. Fiddler -> GET: http://localhost:4020/Games.svc/XboxGames -> XML view
- 58. Add header: Accept: application/json-> Repeat last step
- 59. Change to POST. Change Accept header to Content-Type. Add following (Alt+8) to body{"Arcade":true,"Genre":"RTS","Image":"smile.jpg","MSPointsCost":1200,"PK":"2B0E0DB8-0DCF-4654-B225-61B57114A2EF","Rating":"E10","ReleaseDate":"\/Date(1261519200000)\/","RetailCost":"0","Title":"Starcraft 2"}This will fail due to a bug in .NET which requires A METRIC TON of code to work around or just use Entity Framework without POCO supportDemo 4 – WCF RESTAdd new project -> WCF REST Service App -> Name: WCFRest
- 60. Project Properties -> Web -> Specific Port: 4040
- 62. Global.Asax -> AppStart -> Add (Alt+9):Database.ConnectionString = @"data source=C:\Users\Robert MacLean\Desktop\RESTful\WCFRest\bin\superstore.sqlite";Global.asax -> Remove the route prefix (Service1) -> Should look like: RouteTable.Routes.Add(new ServiceRoute("", new WebServiceHostFactory(), typeof(Games)));
- 63. Rename Service1.cs to Games.cs
- 65. Game.cs: Replace SampleItem with Game (Current Doc only, Match Whole Word, ReplaceAll)
- 66. Game.cs: Change content of GetCollection to (Ctrl+Alt+0): return Database.Instance.Games.ToList();
- 67. Change Get method content to (Ctrl+Alt+1):Guid pk = Guid.Parse(id);return Database.Instance.Games.Where(g => g.PK == pk).Single();Run without debugging
- 69. Add accept header: Accept: application/jsonand execute.
- 71. Update create method content to be (Ctrl+Alt+2):Database.Instance.InsertGame(instance);return instance;Update update method to be (Ctrl+Alt+3)[WebInvoke(UriTemplate = "", Method = "PUT")]public Game Update(Game instance){Database.Update(instance); return instance;}Update delete method content (Ctrl+Alt+4) to be:Guid pk = Guid.Parse(id);Database.Delete(Database.Instance.Games.Where(g => g.PK == pk).Single());
- 72. Demo 4 continuedBuild -> Fiddler -> Add Content Type header: Content-Type: application/json
- 73. Add request body (Alt+8) -> POST -> http://localhost:4040
- 78. Browse to: http://localhost:4040/helpASP.NET WebFormsASP.NET MVCWCF Data ServicesWCF REST3rd PartiesOptions for .NET
- 79. Demo in all 4 .NET technologiesFull CRUD on GamesFocus on the REST – Ignore the rest (i.e black box)Work in JSONDemo Goals
- 81. WebFormsNot really built for thisNeed to EVERYTHINGNot recommended unless you have no other optionRecap
- 82. MVCA lot better than WebFormsHelper methods for handling method type, json etc…Multiple return types means more workRecap
- 83. WCF Data ServicesAll done for youGood security modelDesigned with data solutions in mindIssues if not using EF (non-POCO)Powerful client side options OData FormatRecap
- 84. WCF RESTLoads of helpersDesigned with REST in mindNot tied to data solutionsPowerful clientsRecap
- 85. WebForms + MVCWCF REST + WCF Data ServicesMVC + WCF Data ServicesEmbrace Hybrids