Home / Tin tức / tìm hiểu swagger là gì? cách tận dụng swagger để viết api

TÌM HIỂU SWAGGER LÀ GÌ? CÁCH TẬN DỤNG SWAGGER ĐỂ VIẾT API

admin 22/06/2022

Swagger là gì?

Swagger là một phần mềm mã nguồn mở được thực hiện để vạc triển, thiết kế, desgin và có tác dụng tài liệu cho các RESTful web Service.

Bạn đang xem: Tìm hiểu swagger là gì? cách tận dụng swagger để viết api

Có một số phần mượt Swagger như Swagger Editor, Swagger Codegen, Swagger Inspector, Swagger UI.

Trong đó, Swagger UI được thực hiện nhiều nhất, nó hỗ trợ tự động hóa làm tài liệu, sinh code và sinh chạy thử case.

Ví dụ Swagger UI

Để dễ dàng hiểu, các chúng ta cũng có thể truy cập con đường link http://petstore.swagger.io/ để test với Swagger UI

Ta hoàn toàn có thể biết rõ được bao hàm API nào, method và url khớp ứng của nó

Với mỗi api ta lại biết được cụ thể input với output của như ngôi trường nào bắt buộc gửi lên, hiệu quả trả về hoàn toàn có thể nhận mọi status nào…

Bạn cũng rất có thể dễ dàng trình diễn các api vào project của bản thân như bên trên với Swagger UI.

Giả sử bạn là đứa code backend, sau thời điểm code xong các api, Swagger UI sẽ tự động hóa trình bày các API để đứa code front end biết được api này chuyển động như như thế nào và hoàn toàn có thể thực hiện tại test luôn trên Swagger với api đó.

Xem thêm: 4 Bước Kiếm Tiền Với Bca Là Gì ?Thông Tin Của Bca Solutions Giải Đáp Mô Hình Kinh Doanh Bca Solutions

Cài đặt Swagger UI.

Swagger UI là phần mềm mã mối cung cấp mở, bạn cũng có thể download nó trên github https://github.com/swagger-api/swagger-ui

Sau khi download được tệp tin zip, các bạn giải nén ra một folder, trong folder đó sẽ sở hữu thư dist, đây chính là phiên bản Swagger UI mà ta đã sử dụng.

Bạn hoàn toàn có thể copy folder dist với deploy nó lên một hệ thống hoặc mở file index.html bên trên trình duyệt để chạy Swagger UI.

Ở phía trên mình mở luôn file index.html trên trình duyệt.

Xem thêm: Soạn Ngữ Văn 9 Chuyện Cô Gái Nam Xương Của Nguyễn Dữ, Soạn Bài Chuyện Người Con Gái Nam Xương

Kết quả:

Trong ô explore chính là đường linh tới nội dung đặc tả các api. Các bạn cũng có thể thử với http://petstore.swagger.io/v2/swagger.json

Ở bài tiếp sau mình sẽ tiến hành tạo nội dung đặc tả mang lại api từ code tất cả sẵn nhằm hiện lên Swagger UI cùng với project Spring Boot RESTful api