(Đồ án tốt nghiệp) tìm hiểu spring framework xây dựng website quản lý API document sử dựng swagger tool

BỘ GIÁO DỤC VÀ ĐÀO TẠO TRƯỜNG ĐẠI HỌC SƯ PHẠM KỸ THUẬT THÀNH PHỐ HỒ CHÍ MINH ĐỒ ÁN TỐT NGHIỆP NGÀNH CƠNG NGHỆ THƠNG TIN TÌM HIỂU SPRING FRAMEWORK & XÂY DỰNG WEBSITE QUẢN LÝ API DOCUMENT SỬ DỤNG SWAGGER TOOL GVHD:TRƯƠNG THỊ NGỌC PHƯỢNG SVTT:NGUYỄN CHÍ TRUNG MSSV:15110346 SVTT:TRẦN NGUYỄN THANH NHƯ Ý MSSV:15110378 SKL005776 Tp Hồ Chí Minh, tháng 07/2019 TRƯỜNG ĐẠI HỌC SƯ PHẠM KỸ THUẬT TP HỒ CHÍ MINH KHOA CƠNG NGHỆ THƠNG TIN BỘ MÔN CÔNG NGHỆ PHẦN MỀM -  - NGUYỄN CHÍ TRUNG - 15110346 TRẦN NGUYỄN THANH NHƯ Ý - 15110378 Đề Tài: TÌM HIỂU SPRING FRAMEWORK & XÂY DỰNG WEBSITE QUẢN LÝ API DOCUMENT SỬ DỤNG SWAGGER TOOL KHÓA LUẬN TỐT NGHIỆP KỸ SƯ CNTT GIÁO VIÊN HƯỚNG DẪN ThS TRƯƠNG THỊ NGỌC PHƯỢNG KHÓA 2015 - 2019 TRƯỜNG ĐẠI HỌC SƯ PHẠM KỸ THUẬT TP HỒ CHÍ MINH KHOA CƠNG NGHỆ THƠNG TIN BỘ MÔN CÔNG NGHỆ PHẦN MỀM -  - NGUYỄN CHÍ TRUNG - 15110346 TRẦN NGUYỄN THANH NHƯ Ý - 15110378 Đề Tài: TÌM HIỂU SPRING FRAMEWORK & XÂY DỰNG WEBSITE QUẢN LÝ API DOCUMENT SỬ DỤNG SWAGGER TOOL KHÓA LUẬN TỐT NGHIỆP KỸ SƯ CNTT GIÁO VIÊN HƯỚNG DẪN ThS TRƯƠNG THỊ NGỌC PHƯỢNG KHÓA 2015 - 2019 ĐẠI HỌC SƯ PHẠM KỸ THUẬT TP HCM CỘNG HỊA XÃ HỘI CHỦ NGHĨA VIỆT NAM KHOA CƠNG NGHỆ THÔNG TIN Độc lập – Tự – Hạnh phúc PHIẾU NHẬN XÉT CỦA GIÁO VIÊN HƯỚNG DẪN Họ tên Sinh viên: Nguyễn Chí Trung MSSV: 15110346 Họ tên Sinh viên: Trần Nguyễn Thanh Như Ý MSSV: 15110378 Ngành: Cơng nghệ Thơng tin Tên đề tài: TÌM HIỂU SPRING FRAMEWORK & XÂY DỰNG WEBSITE QUẢN LÝ API DOCUMENT SỬ DỤNG SWAGGER TOOL Họ tên Giáo viên hướng dẫn: ThS Trương Thị Ngọc Phượng NHẬN XÉT 1.Về nội dung đề tài & khối lượng thực hiện: 2.Ưu điểm: 3.Khuyết điểm: 4.Đề nghị cho bảo vệ hay không? 5.Đánh giá loại: 6.Điểm: TP.HCM, ngày 15 tháng 07 năm 2019 Giáo viên hướng dẫn ThS Trương Thị Ngọc Phượng ĐẠI HỌC SƯ PHẠM KỸ THUẬT TP HCM CỘNG HÒA XÃ HỘI CHỦ NGHĨA VIỆT NAM KHOA CÔNG NGHỆ THÔNG TIN Độc lập – Tự – Hạnh phúc PHIẾU NHẬN XÉT CỦA GIÁO VIÊN PHẢN BIỆN Họ tên Sinh viên: Nguyễn Chí Trung MSSV: 15110346 Họ tên Sinh viên: Trần Nguyễn Thanh Như Ý MSSV: 15110378 Ngành: Công nghệ Thơng tin Tên đề tài: TÌM HIỂU SPRING FRAMEWORK & XÂY DỰNG WEBSITE QUẢN LÝ API DOCUMENT SỬ DỤNG SWAGGER TOOL Họ tên Giáo viên phản biện: ThS Lê Thị Minh Châu NHẬN XÉT 1.Về nội dung đề tài & khối lượng thực hiện: 2.Ưu điểm: 3.Khuyết điểm: 4.Đề nghị cho bảo vệ hay không? 5.Đánh giá loại: 6.Điểm: TP.HCM, ngày 15 tháng 07 năm 2019 Giáo viên phản biện ThS Lê Thị Minh Châu LỜI CẢM ƠN Nhóm em xin chân thành cám ơn khoa Công Nghệ Thông Tin, Bộ Môn Công Nghệ Phần Mềm, trường Đại học Sư Phạm Kỹ Thuật TP Hồ Chí Minh tạo điều kiện thuận lợi cho chúng em thực đề tài Chúng em xin gửi lời cảm ơn chân thành đến cô Trương Thị Ngọc Phượng, người tận tình bảo hướng dẫn nhóm em thực đề tài Bên cạnh đó, chúng em xin gửi lời cảm ơn đến thầy cô giảng viên trường Đại Học Sư Phạm Kỹ Thuật TP Hồ Chí Minh nói chung thầy giảng viên khoa Cơng Nghệ Thơng Tin nói riêng, người giảng dạy, tạo điều kiện cho em tích lũy kiến thức quý báu năm học qua Dù cố gắng hoàn thành đề tài khóa luận yêu cầu, thời gian hạn hẹp khả hạn chế nên chắn khơng tránh khỏi thiếu sót Chúng em mong nhận thơng cảm tận tình bảo thầy bạn Nhóm em xin chân thành cảm ơn ĐẠI HỌC SƯ PHẠM KỸ THUẬT TP HCM CỘNG HÒA XÃ HỘI CHỦ NGHĨA VIỆT NAM KHOA CÔNG NGHỆ THÔNG TIN Độc lập – Tự – Hạnh phúc ĐỀ CƯƠNG KHÓA LUẬN TỐT NGHIỆP Họ tên SV thực 1: Nguyễn Chí Trung Mã Số SV: 15110346 Họ tên SV thực 2: Trần Nguyễn Thanh Như Ý Mã Số SV: 15110378 Thời gian làm khóa luận tốt nghiệp: từ 15/03/2019 đến 15/07/2019 Chun ngành: Cơng Nghệ Phần Mềm Tên đề tài: TÌM HIỂU SPRING FRAMEWORK & XÂY DỰNG WEBSITE QUẢN LÝ API DOCUMENT SỬ DỤNG SWAGGER TOOL Giáo viên hướng dẫn: Ths Trương Thị Ngọc Phượng Nhiệm Vụ Của Khóa Luận Tốt Nghiệp: Tìm hiểu Spring Framework: Spring Boot, Spring Security, Spring Data JPA Tìm hiểu Swagger Tool, WebSocket, Thymeleaf, Restful API Áp dụng kiến thức Spring Framework kiến thức liên quan để xây dựng website quản lý API Document sử dụng Swagger Tool Thời gian thực hiện: Bắt đầu từ 15/03/2018 đến 15/07/2019 KẾ HOẠCH THỰC HIỆN STT Thời gian 15/03/2019 đến 31/03/2019 01/04/2019 đến 15/04/2019 16/04/2019 đến 15/06/2019 16/06/2019 đến 15/07/2019 Chữ ký SV: Nguyễn Chí Trung Chữ ký SV: Trần Nguyễn Thanh Như Ý T.S Đinh Công Đoan ThS Trương Thị Ngọc Phượng STT Tên xử lý Thêm sửa quyền project contributor Xóa contributor khỏi dự án 6.5.18 Giao diện trang Revert Verson File 6.5.18.1 Thiết kế giao diện Hình 53 Giao diện trang revert version file 6.5.18.2 Danh sách xử lý Bảng 56 Danh sách xử lý trang revert version file STT Tên xử lý Xem tất version file Chọn version file để revert 6.5.19 Giao diện trang View Notification 6.5.18.1 Thiết kế giao diện Hình 54 Giao diện trang view nofitication 6.5.18.2 Danh sách xử lý Bảng 57 Danh sách xử lý trang view nofitication STT Tên xử lý Xem tất thông báo Chọn thông báo để xem chi tiết 91 6.5.20 Giao diện trang Manage User 6.5.18.1 Thiết kế giao diện Hình 55 Giao diện trang manage user 6.5.18.2 Danh sách xử lý Bảng 58 Danh sách xử lý trang manage user STT Tên xử lý Sửa quyền người dùng Chặn người dùng Tìm kiếm người dùng 92 6.6 Kiểm thử phần mềm Nhóm lên kế hoạch kiểm thử (lập Test Plan, Test Case chi tiết) website Vì số lượng có hai thành viên nên nhóm tổ chức kiểm thử chéo Thành viên đảm nhiệm lập trình chức kiểm thử thành viên lại ngược lại Dưới số test case tiêu biểu kiểm thử: 6.6.1 Test case hình Login & Registration Bảng 59 Test case – Login & Registration Test case ID Th REG_01 mộ em Kiể pas REG_02 khô Kiể với thự LOG_01 khô Kiể nhậ LOG _02 Kiể LOG_03 val Phải sử dụng kí tự viết thường Phải sử dụng kí tự viết hoa Phải sử dụng kí tự đặc biệt” 6.6.2 Test case hình My Project Bảng 60 Test case – Màn hình My Project Test case ID Kiể loạ trù PRO_01 Kiể PRO_02 Kiể tro PRO_03 94 6.6.3 Biểu đồ thống kê kết test coverage test case hình Login & Registration Screen 70% 100% 100% 90% 100% REG_01 Hình 56 Thống kê kết test hình đăng nhập, đăng ký My Project Screen 100% 100% 70% PRO_01 Hình 57 Thống kê kết test hình quản lý dự án 95 KẾT LUẬN NHỮNG KẾT QUẢ ĐẠT ĐƯỢC - Hiểu rõ kiến thức Spring Framework: Spring Boot, Spring Security, Spring Data JPA - Hiểu rõ kiến thức Swagger Tool, WebSocket, Thymeleaf, Restful API - Xây dựng thành công website quản lý API Document sử dụng Swagger Tool với việc áp dụng kiến thức tìm hiểu NHỮNG KHÓ KHĂN KHI THỰC HIỆN ĐỀ TÀI Rủi ro yếu tố tồn môi trường hoạt động, sản xuất, dự án công nghệ thông tin phát triển phần mềm không ngoại lệ Tuy nhiên với đặc thù riêng, mà nhiều dự án phần mềm bỏ qua khâu nhận diện rủi ro – khó khăn gặp phải dẫn đến kết không tốt hay thất bại Dưới số rủi ro – khó khăn mà nhóm gặp phải dự án: Cơng nghệ: Bảng 61 Khó khăn công nghệ dự án STT Rủi ro, khó k Install Spring Tool đến Eclipse nặng v Xác minh 2FA qu verification code p 96 Quy trình nghiệp vụ: Bảng 62 Khó khăn quy trình nghiệp vụ dự án STT Rủi ro, khó k Source code doc quan thay đổi theo thời Phạm vi, yêu cầu kinh phí tăng Thực dự án khơng Các lỗi phát sinh giải Con người: Bảng 63 Khó khăn người dự án STT Rủi ro, khó k Kỹ làm việc nhóm tốt Lịch trình họp nhóm k phải thực tập Mỗi người có phon code khác ƯU ĐIỂM - Giao diện đơn giản giúp người dùng dễ dàng sử dụng lần - Xây dựng website quản lý API Document giúp cải thiện trải nghiệm người tham gia xây dựng API, tiết kiệm thời gian hỗ trợ, chi phí dễ bảo trì HẠN CHẾ Dù nhóm cố gắng tìm hiểu phát triển website cách tốt nhất, giới hạn thời gian khả thân hạn chế, nên khơng tránh khỏi thiếu sót, khuyết điểm: Giao diện chưa đẹp mắt, cịn sơ sài Thuật tốn chưa tối ưu hóa KINH NGHIỆM ĐẠT ĐƯỢC Sau q trình thực dự án, nhóm rút nhiều kinh nghiệp cho thân Để làm tốt cơng việc nói chung hay dự án cơng nghệ thơng tin nói riêng điều tiên cần có kiến thức lý thuyết vững, cần phải có kinh nghiệm thực tế qua q trình làm dự án Kinh nghiệm khơng bao gồm học mà bao gồm kỹ mềm giao tiếp hay làm việc nhóm,… So với dự án thực trước dự án sau ln có cải tiến tốt hơn, từ rút kinh nghiệm cần có: Cần rèn luyện kỹ làm việc nhóm, kỹ trình bày, khơng trì hỗn, ln chủ động Nắm vững lý thuyết tìm hiểu áp dụng vào project nhỏ trước dùng vào project thức Giao diện sử dụng custom lại từ public resource internet để tiết kiệm thời gian, chi phí Tận dụng tối đa thư viện, công cụ hỗ trợ giúp project tốt giảm thiểu chi phí Quan tâm đến vấn đề bảo mật trải nghiệm người dùng Không nên áp đặt ý kiến chủ quan làm ảnh hưởng đến UX Thực việc test sớm test kỹ từ đầu để giảm nguy sinh lỗi hạn chế rủi ro 98 Lưu trữ phiên project Git SVN, commit ghi rõ description để dễ dàng backup Tất tài liệu chỉnh sửa cần có sheet lưu lại lịch sử lần chỉnh sửa version tài liệu Việc clean code, optimize code quan trọng Nhóm nên đưa quy định chung format code HƯỚNG PHÁT TRIỂN TRONG TƯƠNG LAI Mặc dù tồn hạn chế bên trên, với tâm nhóm, website khắc phục tiếp tục nâng cấp, cải tiến nhằm tiến tới hồn hảo Nhóm tìm hiểu đưa file API lên S3 AWS tạo lịch trình backup file để tối ưu hóa dung lượng lưu trữ cho server Nhóm cải thiện giao diện để đạt chuẩn UX/UI Nhóm thiết kế giao diện để chuẩn responsive thiết bị mobile Phát triển thêm chức backup liệu chức call video để tăng suất tính tiện dụng cho website Bên cạnh đó, cải tiến code để tốc độ xử lý request trả response nhanh 99 TÀI LIỆU THAM KHẢO [1] https://www.thymeleaf.org/ [2] https://techtalk.vn/tat-tan-tat-ve-api.html [3] https://viblo.asia/p/thiet-ke-restful-api-GrLZD98Vlk0 [4] https://viblo.asia/p/hieu-hon-ve-websocket-znVGL2r0RZOe [5] https://docs.spring.io/spring/docs/current/spring-framework-reference/ [6] https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html [7] https://www.journaldev.com/2888/spring-tutorial-spring-core-tutorial [8] https://o7planning.org/en/11267/spring-boot-tutorial-for-beginners [9] https://docs.spring.io/spring-data/jpa/docs/current/reference/html/ [10] https://www.baeldung.com/security-spring [11] https://swagger.io/solutions/api-documentation/ [12] https://swagger.io/solutions/api-design/ [13] https://swagger.io/tools/swagger-editor/ [14] https://swagger.io/tools/swagger-ui/ 100 ... tài: TÌM HIỂU SPRING FRAMEWORK & XÂY DỰNG WEBSITE QUẢN LÝ API DOCUMENT SỬ DỤNG SWAGGER TOOL Giáo viên hướng dẫn: Ths Trương Thị Ngọc Phượng Nhiệm Vụ Của Khóa Luận Tốt Nghiệp: Tìm hiểu Spring Framework: ... kiến thức tìm hiểu, đặt biệt Spring Framework để xây dựng website quản lý API Document sử dụng Swagger Tool PHÂN TÍCH NHỮNG CƠNG TRÌNH CĨ LIÊN QUAN Hiện số lượng ứng dụng quản lý API Document. .. Spring Boot, Spring Security, Spring Data JPA Tìm hiểu Swagger Tool, WebSocket, Thymeleaf, Restful API Áp dụng kiến thức Spring Framework kiến thức liên quan để xây dựng website quản lý API Document