Swag Doc
SwagDoc tự động tạo tài liệu Swagger/OpenAPI từ lưu lượng API của bạn mà không cần thay đổi mã.
Liệt kê trong các danh mục:
Năng suấtCông cụ phát triểnDanh mục
Mô tả
SwagDoc tự động tạo tài liệu Swagger/OpenAPI từ lưu lượng API của bạn mà không cần thay đổi mã. Nó ghi lại và phân tích các yêu cầu và phản hồi HTTP như một proxy để suy ra cấu trúc API, kiểu dữ liệu và sơ đồ, giúp việc tài liệu API trở nên dễ dàng.
Cách sử dụng Swag Doc?
Để sử dụng SwagDoc, hãy thiết lập nó như một proxy trước API của bạn bằng cách chạy lệnh 'swagdoc proxy --port 8080 --target http://yourapiserver.com'. Điều này sẽ khởi động một máy chủ proxy ghi lại lưu lượng cho tài liệu. Sau khi ghi lại lưu lượng, hãy tạo tài liệu Swagger/OpenAPI bằng cách sử dụng 'swagdoc generate --output swagger.json'.
Tính năng chính của Swag Doc:
1️⃣
Hoạt động như một proxy để ghi lại lưu lượng API
2️⃣
Phân tích các yêu cầu và phản hồi HTTP để suy ra cấu trúc API
3️⃣
Tự động phát hiện kiểu dữ liệu, tham số và sơ đồ phản hồi
4️⃣
Tạo tài liệu OpenAPI/Swagger dựa trên lưu lượng quan sát được
5️⃣
Không cần thay đổi mã cho API hiện có của bạn
Tại sao nên sử dụng Swag Doc?
| # | Trường hợp sử dụng | Trạng thái | |
|---|---|---|---|
| # 1 | Tự động tài liệu API mà không cần sửa đổi mã | ✅ | |
| # 2 | Dễ dàng tạo thông số OpenAPI cho các API hiện có | ✅ | |
| # 3 | Tổ chức tài liệu API thành các nhóm hợp lý dựa trên đường dẫn URL | ✅ | |
Do ai phát triển Swag Doc?
SwagDoc được phát triển bởi một cộng đồng các nhà đóng góp và là mã nguồn mở, cho phép hợp tác và cải tiến từ các nhà phát triển trên toàn thế giới.