swagger là gì

Swagger là gì?

Swagger là một phần mượt mã nguồn msống được áp dụng để phát triển, kiến thiết, xây dừng cùng làm cho tư 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 Coderen, Swagger Inspector, Swagger UI.

Trong số đó, Swagger UI được sử dụng các tốt nhất, nó hỗ trợ auto có tác dụng tư liệu, sinc code và sinh demo case.

lấy ví dụ Swagger UI

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

Ta rất có thể hiểu ra được bao hàm API làm sao, method cùng url tương ứng của nó

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

Bạn cũng có thể dễ ợt trình bày các api vào project của mình nlỗi trên với Swagger UI.

Giả sử các bạn là đứa code backover, sau khoản thời gian code dứt những api, Swagger UI sẽ tự động hóa trình diễn các API nhằm đứa code front kết thúc hiểu rằng api này hoạt động nhỏng như thế nào và rất có thể tiến hành thử nghiệm luôn trên Swagger với api đó.

Xem thêm: Mẹo Chơi Xóc Đĩa Online Đánh Đâu Thắng Đó Của Các Cao Thủ, Cách Chơi Xóc Đĩa Giỏi Dễ Thắng Nhất Online

Cài đặt Swagger UI.

Swagger UI là ứng dụng mã nguồn mở, chúng ta có thể download nó trên github https://github.com/swagger-api/swagger-ui

Sau Lúc sở hữu được file zip, chúng ta giải nén ra một folder, trong thư mục kia sẽ có được tlỗi dist, trên đây đó là bản Swagger UI mà ta sẽ sử dụng.

quý khách hàng hoàn toàn có thể copy folder dist cùng deploy nó lên một VPS hoặc mngơi nghỉ tệp tin index.html bên trên trình phê chuẩn để chạy Swagger UI.

Ở phía trên bản thân mngơi nghỉ luôn file index.html bên trên trình chăm chú.

Kết quả:

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

Ở bài xích tiếp sau mình vẫn thực hiện sản xuất nội dung sệt tả cho api tự code 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 đến API RESTful Web Service toludenim.com

Okay, Done!

References:

swagger.io/docs/specification/about

This entry was posted in Web Service và tagged swagger. Bookmark the permaliên kết.

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

← Msinh hoạt những project, module cùng lúc vào Intellij
Code ví dụ Spring Boot Hello World với Intellij IDEA →

Web Service

Chuyên mục