tạo restful api web service trong java spring boot

Posted on by adminChuyên mục:Kiến thức Internet

Restful api web service là gì, Hướng dẫn tạo restful api web service trong java web sử dụng spring boot

Trong bài viết này, laptrinhjavaweb muốn giới thiệu cho các bạn biết restful api web service là gì

Sau khi tìm hiểu được khái niệm restful api web service là gì thì laptrinhjavaweb tiếp tục hướng dẫn các bạn tạo web services trong java web sử dụng spring boot như thế nào với các đội tượng:

@ Controller, @ RequestBody, @ ResponseBody, @ RequestMapping, @ RestController, @ GetMapping, @ PostMapping, @ PutMapping, @ DeleteMapping …

Việc tạo restful api web service trong java web sử dụng spring boot cũng như biết về khái niệm restful api web service là gì giúp ích rất nhiều cho các bạn khi join khóa học spring boot cơ bản miễn phí của laptrinhjavaweb: LINK KHÓA HỌC

Khóa học spring boot cơ bản miễn phí

– Học spring boot cơ bản miễn phí: XEM TẠI ĐÂY

Restful api web service là gì

Mô tả restful api web service là gì của TIKI với mô hình đơn giản 

Web service thì có 2 dạng :
– SOAP
– REST
Dạng mà tất cả chúng ta hay xài nhất đó là REST, nó sử dụng kiểu tài liệu JSON để tương tác
Nhìn vào hình trên bạn sẽ rõ, app và web chắc như đinh cách binding data hay truy vấn tới server nó sẽ khác nhau, tuy nhiên để đồng nhất tài liệu, mạng lưới hệ thống TIKI ví dụ điển hình họ sẽ dùng chính sách này để đồng điệu. Khi ta biến hóa data trên app hay web thì cả web và app sẽ đồng điệu tài liệu như nhau. Như đã nói, cách binding data và truy vấn tài liệu của app hay web sẽ khác nhau, do đó tất cả chúng ta cần 1 kĩ thuật để đồng điệu input hay output khi app hay web truyền data về server và ngược lại. Và kĩ thuật dùng ở đây đó chính là web service và đơn cử tất cả chúng ta sử dụng REST API với JSON data .
Vậy restful web service được build như thế nào khi tất cả chúng ta sử dụng spring boot, giờ đây zô nhé bà con

Các phần mềm và thư viện sử dụng

– Apache maven 3.6.0
– Eclipse EE
– JDK 1.8
– spring boot 1.5.9. RELEASE
– Postman
Download những ứng dụng tại đây : LINK DOWNLOAD

Để học được bài này, các bạn phải xem qua bài tạo project spring boot nhé: LINK BÀI VIẾT

Các bạn làm theo các bước như sau

1.1 Sử dụng @Controller

trong package com.laptrinhjavaweb.api bạn tạo 1 file có tên là NewAPI. java và copy đoạn code phía dưới vào
@ Controller

public class NewAPI {

        @RequestMapping(value = “/new”, method = RequestMethod.POST)

@ ResponseBody

        public NewDTO createNew(@RequestBody NewDTO model) {

                return model;

}
}
@ Controller : định nghĩa NewAPI từ 1 java class thành 1 API web service trong spring boot, hiểu đơn thuần là biến 1 java class thường thì thành 1 API trong restful web service của spring boot
@ RequestMapping : tìm kiếm theo đúng URL của request từ client
RequestMethod. POST : là 1 trong 4 HTTP method, POST được dùng trong những trường hợp thêm tài liệu vào trong database
Khi viết API, bắt buộc tất cả chúng ta phải định nghĩa HTTP method cho API đó
@ RequestBody : nhận tài liệu json được truyền từ client vào server
@ ResponseBody : trả hiệu quả json từ server về client

1.2 Sử dụng @RestController

@ RestController

public class NewAPI {

@ PostMapping ( ” / new ” )

        public NewDTO createNew(@RequestBody NewDTO model) {

                return model;

}
}

 

@ RestController sửa chữa thay thế cho @ Controller + @ ResponseBody
@ PostMapping sửa chữa thay thế cho @ RequestMapping + RequestMethod. POST

Chú ý:

1 số nguyên tắc khi viết API :
– Tên api phải là danh từ
– http method phải đúng với thao tác
Thêm : POST
Sửa : PUT
Xóa : DELETE
Hiển thị tài liệu : GET

2. Tạo NewDTO

2.1 Tạo package com.laptrinhjavaweb.dto
2.2 Trong package com.laptrinhjavaweb.dto tạo 1 file có tên NewDTO. java và copy đoạn code phía dưới vào file

public class NewDTO {

       private String title;

       private String content;  

       public String getTitle() {

             return title;

}

       public void setTitle(String title) {

             this.title = title;

}

       public String getContent() {

             return content;

}

       public void setContent(String content) {

             this.content = content;

}
}

3. Test api

Sau khi triển khai xong những bước trên, tất cả chúng ta đi vào phần test api, để kiểm tra xem API đó có work không
Phần mềm sử dụng để test api đó là PostMan, bạn nào chưa có thì tải về tại đây https://www.postman.com/downloads/
3.1 Mở postman lên nhập những thông tin như hình

3.2 Anh em run con spring boot lên và chạy postman, nếu nó ra hiệu quả như hình bên dưới thì đồng đội đã thành công xuất sắc rồi nhé

Chú ý: anh em nào mà chưa biết tạo và run project spring boot api web service thì xem lại bài này nhé TẠO PROJECT SPRING BOOT

Kết quả sau khi run

Khóa học spring boot cơ bản miễn phí

– Học spring boot cơ bản miễn phí: XEM TẠI ĐÂY

Follow nhóm zalo, fanpage, facebook cá thể, group facebook, kênh youtube để nhận những nội dung về lập trình java core, java web hay ho

– Fanpage : XEM TẠI ĐÂY
– Facebook cá thể : XEM TẠI ĐÂY

– Nhóm Zalo: https://zalo.me/g/hjeert065

– Nhóm học lập trình java core : XEM TẠI ĐÂY
– Nhóm học lập trình java web : XEM TẠI ĐÂY
– Kênh youtube của laptrinhjavaweb : XEM TẠI ĐÂY

admin