SWAGGER LÀ GÌ

Swagger là gì?

Swagger là một phần mượt mã mối cung cấp msinh hoạt được áp dụng để cải cách và phát triển, thi công, tạo cùng làm cho tài liệu cho các RESTful Web Service.

Bạn đang xem: Swagger là gì

Có một vài ứng dụng Swagger nlỗi Swagger Editor, Swagger Codegene, Swagger Inspector, Swagger UI.

Trong số đó, Swagger UI được thực hiện các tuyệt nhất, nó hỗ trợ tự động làm tài liệu, sinh code cùng sinch chạy thử case.


lấy ví dụ Swagger UI

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

Ta rất có thể hiểu rõ được bao hàm API nào, method và url tương ứng của nó

*

Với mỗi api ta lại hiểu rằng chi tiết input cùng output của nhỏng trường như thế nào đề nghị gửi lên, công dụng trả về có thể nhận thêm các status nào…

*
*

quý khách hàng cũng có thể dễ dàng trình diễn những api trong project của bản thân nhỏng trên cùng với Swagger UI.

Giả sử bạn là đứa code backkết thúc, sau khi code dứt các api, Swagger UI sẽ auto trình bày những API để đứa code front end hiểu rằng api này hoạt động nhỏng như thế nào và hoàn toàn có thể triển khai thử nghiệm luôn trên Swagger cùng với api kia.

Xem thêm: Chứng Quyền Là Gì Ssi Phát Hành Thêm 8 Mã Chứng Quyền Mới, Kiến Thức Cơ Bản Về Chứng Quyền Có Đảm Bảo

Cài đặt Swagger UI.

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


*

Sau lúc thiết lập được file zip, chúng ta bung file ra một folder, trong thư mục đó sẽ sở hữu thỏng dist, đây chính là bạn dạng Swagger UI mà ta đã sử dụng.

Quý Khách có thể copy folder dist với deploy nó lên một VPS hoặc msinh hoạt tệp tin index.html bên trên trình lưu ý nhằm chạy Swagger UI.

Tại trên đây bản thân mnghỉ ngơi luôn file index.html bên trên trình chăm nom.

*

Kết quả:

*

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

Ở bài bác tiếp theo sau bản thân sẽ tiến hành sản xuất văn bản sệt tả mang lại api từ code có sẵn để hiện lên Swagger UI cùng với project Spring Boot RESTful api

Swagger là gì? Tạo document mang lại API RESTful Web Service obatambeienwasirherbal.com

Okay, Done!

References:

swagger.io/docs/specification/about


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

Điều hướng bài viết


← Msinh sống nhiều project, module cùng lúc trong Intellij
Code ví dụ Spring Boot Hello World cùng với Intellij IDEA →
*

Tìm kiếm cho:

Web Service

Chuyên ổn mục


*
*