lợi ích của việc sử dụng mùa xuân REST của Documents so với Swagger

Question

Xuân REST của Documents là gì đã được phát hành gần đây và các tài liệu nói:

Cách tiếp cận này giải phóng bạn khỏi những hạn chế áp đặt bởi các công cụ như Swagger

Vì vậy, tôi muốn hỏi khi Spring REST Docs là thích hợp hơn để sử dụng so sánh với Swagger và hạn chế nó giải phóng.

Answer 1

Tôi chỉ thấy một bài thuyết trình ở đây là chạm về câu hỏi của bạn trong số các chủ đề khác:

https://www.youtube.com/watch?v=k5ncCJBarRI&t=26m58s

• Swagger không hỗ trợ hypermedia ở tất cả/đó là URI centric

• Phương pháp kiểm tra mã của Swagger có thể tụt lại sau mã của bạn. Có thể thực hiện thay đổi trong mã của bạn mà Swagger không hiểu và sẽ không xử lý đúng cách cho đến khi Swagger được cập nhật.

• Chuyển đổi yêu cầu nhiều chú thích và thật khó để bao gồm văn bản mô tả bạn muốn trong tài liệu api trong chú thích.

• Chỉ có một số điều mà Swagger không thể tìm ra từ việc kiểm tra mã của bạn.

Trong mọi trường hợp, đây chỉ là một vài điểm. Người trình bày làm một công việc tốt hơn nhiều để thảo luận về nó hơn tôi có thể.

Answer 2

Có một số hạn chế với vênh và ngăn xếp mùa xuân cụ thể.

Ví dụ: với "param" trong Ánh xạ yêu cầu, bạn có thể xác định nhiều phương thức với cùng một url để đơn giản hóa mã của bạn. Nhưng vênh vang cho bạn thấy chỉ là một phương pháp

Answer 3

Tôi nghĩ rằng tôi sẽ kêu vang trong để cung cấp cho một chút bối cảnh xung quanh Swagger, nó là gì, và những gì nó không phải là. Tôi tin rằng điều này có thể giúp trả lời câu hỏi của bạn.

Swagger 2.0 đang được chấp nhận bởi rất nhiều tên tuổi lớn và nền tảng lớn như Microsoft Azure, Paypal, SwaggerHub.com, DynamicApis.com, v.v ... Một điều cần ghi nhớ là Swagger is very simply a specification. Nó không phải là một khuôn khổ. Có rất nhiều frameworks đã được xây dựng để tạo ra đầu ra Swagger thu thập dữ liệu thông qua mã của bạn xem thông tin API của bạn để xây dựng tệp JSON Swagger 2.0 đại diện cho API của bạn. Giao diện người dùng Swagger mà bạn thấy các API của mình được định hướng trực tiếp từ tệp JSON Swagger 2.0 này. hãy sử dụng nó để kiểm tra nó ra

Điều quan trọng cần lưu ý là một khung được tạo ra để cho phép bạn "sử dụng" không phải là cách Swagger phải làm việc (tức là hoàn toàn phụ thuộc vào việc thực hiện khung bên). Nếu khung công tác mà bạn đang sử dụng để tạo các tài liệu Swagger 2.0 và giao diện người dùng của bạn không hoạt động cho bạn thì bạn sẽ có thể đi tìm một khung công tác khác để tạo ra các đồ tạo tác Swagger và trao đổi các công nghệ.

Hy vọng điều này sẽ hữu ích.