ASP.Net Web API.

Transcription

1 ASP.Net Web API 1

2 מה זה? Web API View בלבד ולא Data אותו מממש השרת והוא מחזיר לקליינט API הוא Web API הבקשה והתשובה הן בפרוטוקול Http\Https הקליינטים של Web API יכולים להיות רבים : אפשר להשתמש גם בMVC ASP.Net להחזיר לקליינט Data אבל WEB API יותר מתאים ונוח Desktop Application Http\Https Mobile App Server Web API Web Client Data 2

3 דוגמאות ל Web API דוגמאות ידועות ל : Web API / / ועוד רבים 3

4 ASP.Net Web API Microsoft מאפשרת לנו לכתוב שרת אשר מממש Web API כך שקליינטים יוכלו לפנות אליו ולקבל מידע התשתית שמאפשרת זאת נקראת ASP.Net Web API התשתית הזו מאוד דומה ל ASP.Net MVC ההבדל המרכזי הוא ש ASP.Net MVC יכול להחזיר View ויכול להחזיר Data ואילו ASP.Net Data יכול להחזיר רק Web API 4

5 מה זה? REST Representational State Transfer - הוא ראשי תיבות של REST REST הוא architectural pattern ליצירת API שמשתמש ב HTTP לתקשורת REST הומצא בשנת 2000 WEB API נמצא בשימוש רוב האתרים שחושפים REST 5

6 דוגמא לשימוש בREST עבור אתר הבלוגים שלנו Resource HTTP method Expected output Response Code /api/blogs GET החזרת רשימת כל הבלוגים 200/OK /api/blogs POST יצירת בלוג חדש 201/Created /api/blogs/73 PUT 73 הוא עדכן מידע בלוג קיים שהid 204/No Content or 200/OK /api/blogs/73 DELETE 73 הוא מחק בלוג קיים שהid 204/No Content or 200/OK /api/blogs/73 GET הוא 73 שלו החזרת מידע בלוג שהid 200/OK 404/Not Found כאשר id לא נמצא מחזירים טבלה בעזרתה אפשר לממש.CRUD את המידע עובר ב PUT/POST אפשר להעביר כ querystring שנוסף ל url או ב של הrequest body נובע מrouting עם api controller בשם BlogsController 6

7 נוסיף ספריה api תחת ספרית Controllers של פרויקט קיים של.ASP.Net MVC לצורך הדוגמה נוסיף את זה לפרויקט בלוגים שעשינו בפרק Framework" "ASP.Net MVC + Entity (יש להסיר את השדות עם virtual ב (Models נסמן את הספריה api ומקש ימני Add->Controllers->Web API 2 Controller - Empty שימוש ב ASP.Net Web API שימו לב שמלבד הcontroller נוסף בין השאר WebApiConfig.cs שמגדיר את הrouting עבור הAPI Web שימו לב שהrouting לא כולל!!!! Action למרות זאת נראה בהמשך שaction מתאים יקרא בהתאם ל http methodומספר הארגומנטים לaction 7

8 תוספות פעם בפרויקט לאחר הוספת web api controller The Global.asax.cs file in the project may require additional changes to enable ASP.NET Web API. 1. Add the following namespace references: using System.Web.Http; using System.Web.Routing; 2. If the code does not already define an Application_Start method, add the following method: protected void Application_Start(){ 3. Add the following lines to the beginning of the Application_Start method: GlobalConfiguration.Configure(WebApiConfig.Register); לאחר הוספת ה controller מקבלים README ויש לבצע את ההוראות הרשומות להלן 8

9 להוסיף במידה ויש בעיית גישה מדפדפן מקומי לשרת מקומי PM > Install-Package Microsoft.AspNet.WebApi.Cors לעשות ב Package Manager Console var cors = new EnableCorsAttribute("*", "*", "*"); config.enablecors(cors); לעשות בפונקציה Register של המחלקה WebApiConfig ראה מקור 9

10 דוגמה ל Web API דוגמא לAPI WEB עבור אתר בלוגים מופיע כאן with_mvc/blogsmvc_ef תחת ספרית Controllers יש ספרית api ושם יש BlogsController שיורש את ApiController ניתן לגשת אליו גם מPostman וגם מקליינט של Angular 2 וגם מקליינט של Ionic 2 כרגע צריך לשים את המידע של PUT POST בquerystring וזה עובד יפה אם הaction של PUT POST מקבל אוביקט לדוגמא Blog אז אפשר בpostman להעביר אותו ב body->raw->json (application/json) 10

11 קריאת כל הבלוגים // /api/blogs [HttpGet] public IEnumerable<Blog> GetBlogs() { return m_db.blogs; 11

12 קריאת בלוג אחד // GET /api/blogs/1 [HttpGet] public IHttpActionResult GetBlog(long id){ Blog blog = m_db.blogs.find(id); if (blog == null){ return NotFound(); return Ok(blog); 12

13 יצירת בלוג // POST /api/blogs [HttpPost] public IHttpActionResult CreateBlog(string title,string description){ if (!validationisok(title,description)){ return BadRequest(); Blog blog = new Blog { Title = title, Description = description ; מאפשר גישה דרך request ב querystring m_db.blogs.add(blog); m_db.savechanges(); return CreatedAtRoute("DefaultApi", new { id = blog.id, blog); 13

14 יצירת בלוג - גישה שניה // POST /api/blogs [HttpPost] public IHttpActionResult CreateBlog(Blog blog){ if ((blg!= null) &&!validationisok(blog.title, blog.description)){ return BadRequest(); העברת אוביקט מסוג Blog מאפשרת השמתו ב request ב body כאוביקט JSON אבל לא כquerystring m_db.blogs.add(blog); m_db.savechanges(); return CreatedAtRoute("DefaultApi", new { id = blog.id, blog); 14

15 עריכת בלוג // PUT /api/blogs/4 -> update blog with id 4 [HttpPut] public IHttpActionResult UpdateBlog(long id, string title,string description){ if (!validationisok(title,description)){ return BadRequest(); Blog blog = m_db.blogs.find(id); מאפשר גישה דרך request ב querystring if (blog == null){ return NotFound(); blog.title = title;blog.description = description; m_db.savechanges(); return StatusCode(HttpStatusCode.NoContent); 15

16 // PUT /api/blogs/4 -> update blog with id 4 עריכת בלוג - גישה שניה [HttpPut] public IHttpActionResult UpdateBlog(long id,blog blg){ if ((blg!= null) &&!validationisok(blg.title, blg.description)){return BadRequest(); if (id!= blg.id){return BadRequest(); העברת אוביקט מסוג Blog מאפשרת השמתו ב request בbody כאוביקט JSON אבל לא כquerystring Blog blog = m_db.blogs.find(blg.id); if (blog == null){return NotFound(); blog.title = blg.title;blog.description = blg.description; m_db.savechanges(); return StatusCode(HttpStatusCode.NoContent); 16

17 מחיקת בלוג // DELETE /api/blogs/4 -> delete blog with id 4 [HttpDelete] public IHttpActionResult DeleteBlog(long id){ Blog blog = m_db.blogs.find(id); if (blog == null){ return NotFound(); m_db.blogs.remove(blog); m_db.savechanges(); return Ok(blog); 17