Swagger và RESTful nguồn tài nguyên thù địch mùa xuân

Question

Trong API RESTful của tôi, tất cả các tài nguyên đang mở rộng cơ sở ResourceSupport của Spring, để đảm bảo hiệu trưởng thù địch theo thiết kế. Ví dụ:

public class PoolResource extends ResourceSupport { 
    private String name; 
    ... 
} 

Tôi cũng đang sử dụng Swagger, và tôi đã tự hỏi: là nó có thể cấu hình các vênh vang-ui bằng cách nào đó, để bỏ qua các thuộc tính đến từ ResourceSupport?

(Swagger-ui cung cấp một lối vào thoải mái và dễ dàng của API. Là một trong những lợi ích chính của việc sử dụng Swagger, API là dễ hiểu và chơi xung quanh với các API cho những người, những người thậm chí không quen thuộc với REST API ... miễn là "liên kết" và "rels" đi vào hình ảnh.)

Answer 1

Cách duy nhất hợp lý để ẩn nó sẽ ẩn nó khỏi chính mô hình (có một số cách để làm điều đó, mặc dù nếu bạn sử dụng Spring MVC, tôi không chắc chắn những gì swagger-springmvc hỗ trợ).

Bạn về lý thuyết có thể hack swagger.js để ẩn nó, nhưng đó là một cuộc phiêu lưu hoàn toàn.

Answer 2

Tôi khuyên bạn nên vứt bỏ vênh vang và sử dụng một người trông giống như Postman. Postman tạo các liên kết được cung cấp bởi spring-hateoas có thể nhấp, vì vậy bạn có thể điều hướng thông qua API khá nhanh chóng. Nếu bạn muốn cung cấp một số thông tin/tài liệu bổ sung, bạn có thể lưu các yêu cầu đó vào bộ sưu tập yêu cầu trong Postman và xuất nó để phân phối. Sau khi tôi đã thử một số công cụ tài liệu để nghỉ ngơi apis, bao gồm raml, swagger, apiary và cuối cùng Postman-bộ sưu tập kết hợp với hateaos, tôi đã tìm thấy sau này là một trong những tôi hài lòng nhất với.

Answer 3

Với mùa xuân dữ liệu REST của 2.4.0.RELEASE, bây giờ bạn có nhiều hình thức siêu dữ liệu:

• ALPS
• JSON Schema
• Cài đặt HAL duyệt qua lò xo dữ liệu còn lại-hal-trình duyệt mô-đun và lướt qua hypermedia

Answer 4

Spring RestDocs được xây dựng với hyermedia. Nó hoạt động để cung cấp cùng một lợi ích như vênh trong lĩnh vực "tài liệu được tạo" nhưng không phải là URL.

http://docs.spring.io/spring-restdocs/docs/current/reference/html5/#getting-started-build-configuration

phấn đấu để ra một cái gì đó nhiều hơn phù hợp với githubs docs (Hyermedia'd).

https://developer.github.com/v3/#current-version

Answer 5

Bất kỳ một nhìn HAL Trình duyệt

http://api.opensupporter.org/hb2/browser.html#/api/v1

Nó giúp hình dung web của mối quan hệ giữa các nguồn lực, vì vậy doesnt nhất thiết thể hiện ví dụ yêu cầu một tài nguyên, nhưng không có khu vực để hiển thị tài liệu .

Suy nghĩ của tôi là một cách dễ dàng hơn để có được bản thực thi Hateos tự được ghi lại, ở mức độ nào đó. Và có lẽ một trong những liên kết siêu văn bản đó có thể là một trang web được chia sẻ hoặc Các giá trị được chấp nhận có thể nằm trong tài liệu tôi đã đề cập ở trên.