Tìm hiểu về swagger

  -  

Swagger là gì?

Swagger là một phần mềm mã mối cung cấp msống được áp dụng để phát triển, kiến thiết, xuất bản cùng làm tư liệu cho những RESTful Web Service.

Bạn đang xem: Tìm hiểu về swagger

Có một trong những ứng dụng Swagger nlỗi Swagger Editor, Swagger Codegene, Swagger Inspector, Swagger UI.

Trong số đó, Swagger UI được áp dụng các tuyệt nhất, nó cung cấp auto làm tài liệu, sinc code và sinh demo case.


lấy ví dụ như Swagger UI

Để dễ dàng nắm bắt, những bạn cũng có thể truy cập mặt đường link http://petstore.swagger.io/ nhằm demo với Swagger UI

Ta hoàn toàn có thể thấu hiểu được gồm có API làm sao, method và url tương xứng của nó

*

Với từng api ta lại biết được chi tiết input đầu vào và output của nhỏng ngôi trường như thế nào phải gửi lên, hiệu quả trả về hoàn toàn có thể nhận thêm những status nào…

*
*

quý khách cũng hoàn toàn có thể thuận tiện trình bày những api trong project của chính mình nhỏng bên trên với Swagger UI.

Giả sử các bạn là đứa code backend, sau thời điểm code xong các api, Swagger UI sẽ auto trình bày những API nhằm đứa code front over hiểu rằng api này vận động nhỏng làm sao cùng hoàn toàn có thể tiến hành demo luôn luôn trên Swagger với api kia.

Xem thêm: Luật Doanh Nghiệp Tiếng Anh Là Gì ?%% Tìm Hiểu Luật Doanh Nghiệp Tiếng Anh Là Gì

Cài đặt Swagger UI.

Swagger UI là phần mềm mã mối cung cấp msinh sống, chúng ta có thể download nó tại github https://github.com/swagger-api/swagger-ui


*

Sau lúc tải được tệp tin zip, bạn bung file ra một folder, vào folder kia sẽ có được thỏng dist, đây chính là bạn dạng Swagger UI mà ta vẫn áp dụng.

quý khách rất 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 thông qua nhằm chạy Swagger UI.

Tại trên đây bản thân msống luôn luôn file index.html bên trên trình xem xét.

Xem thêm: Reiki Healing Là Gì, Nghĩa Của Từ Heal, Healing Là Gì

*

Kết quả:

*

Trong ô explore chính là mặt đường linch tới câu chữ đặc tả các api. Các bạn cũng có thể test với http://petstore.swagger.io/v2/swagger.json

Tại bài tiếp theo sau bản thân sẽ triển khai chế tạo ra câu chữ quánh tả đến api tự code bao gồm sẵn nhằm tồn tại Swagger UI với project Spring Boot RESTful api

Swagger là gì? Tạo document cho API RESTful Web Service kanamara.vn

Okay, Done!

References:

swagger.io/docs/specification/about


This entry was posted in Web Service và tagged swagger. Bookmark the permalink.

Điều phía bài xích viết


← Mở các project, module cùng lúc vào Intellij
Code ví dụ Spring Boot Hello World với Intellij IDEA →
*

Web Service

Chuyên ổn mục


*
*