Ghi lại API HATEOAS mùa xuân

Question

Có bất kỳ plugin nào ở đó (tương tự như Swagger) cung cấp khả năng ghi lại các API HATEOAS không?

Giao diện Swagger khá tốt nhưng không có hỗ trợ REST cấp 3.

Answer 1

Sau khi điều tra thêm, tôi đã phát hiện trình duyệt HAL (https://github.com/mikekelly/hal-browser) khá tốt. Mặc dù, API của bạn phải trả về kiểu nội dung của HAL cho nó.

Bạn không cần định cấu hình bất kỳ thứ gì trên máy chủ cho công cụ này. Chỉ cần mở nó trong một trình duyệt và trỏ đến API của bạn.

Answer 2

Tôi sử dụng spring-restdocs kết hợp với trình duyệt HAL.

Bạn không nhất thiết cần HAL cho restdocs mặc dù được khuyên dùng.

Restdocs sẽ tạo mẫu mã và liên kết & mô tả trường theo định dạng asciidoc. Sau đó, bạn có thể liên kết đến các asciidocs này từ bên trong trình duyệt HAL.

Để xem kết quả hoạt động (mặc dù mã này được mã hóa cứng), hãy kiểm tra điều này: foxycart. Nhấp vào liên kết tài liệu nhỏ bên cạnh các liên kết.