LabCollector  cung cấp các tùy chọn thiết lập khác nhau. Nó đã sẵn sàng để sử dụng (trong chừng mực có thể), cấu hình của nó có thể được quản lý dễ dàng bởi Quản trị viên cấp cao để đáp ứng các yêu cầu cụ thể của phòng thí nghiệm. Là một phần của việc này, LabCollector cung cấp một Giao diện người dùng Swagger cho phép bạn khám phá và thử nghiệm REST API.

Đi vênh vang là một giao diện dựa trên web cung cấp cách tương tác thân thiện với người dùng với API. Nó cho phép người dùng xem các điểm cuối API có sẵn, các tham số của chúng và phản hồi mà chúng trả về. Người dùng cũng có thể gửi yêu cầu tới API và xem phản hồi trong thời gian thực.

Trong Cơ sở Kiến thức sau đây, chúng tôi sẽ hướng dẫn bạn cách sử dụng LabCollector's Swagger, chúng tôi cũng sẽ đề cập đến cách truy cập Giao diện người dùng Swagger, cách khám phá và kiểm tra các điểm cuối API có sẵn cũng như cách tạo tài liệu tự động dựa trên đặc tả OpenAPI.

1. Làm cách nào tôi có thể truy cập LabCollectorSwagger của?

2. Làm cách nào để kiểm tra điểm cuối API?

1. Làm cách nào tôi có thể truy cập LabCollectorSwagger của?

Để định cấu hình API dịch vụ web của bạn, chỉ cần truy cập QUẢN TRỊ -> KHÁC -> CÀI ĐẶT -> API dịch vụ web:

• Một loạt ứng dụng mới dựa trên LabCollector instance có thể được thực hiện và phát triển.
• Sử dụng LabCollector Là cơ sở dữ liệu phụ trợ, phòng thí nghiệm có thể cung cấp thông tin từ xa trong các danh mục bên ngoài, tài nguyên sinh học, v.v.
  
• LabCollector cung cấp cho bạn các dịch vụ API có thể giúp bạn kết nối ứng dụng của bên thứ ba với LabCollector.

           * Để biết thêm thông tin, vui lòng tham khảo tại đây KB.

Có thể dễ dàng truy cập Swagger bằng cách nhấp vào biểu tượng màu cam nằm ở bên phải Ứng dụng bạn muốn tích hợp (như trong ảnh chụp màn hình bên dưới).

Khi bạn đã nhấp vào biểu tượng Swagger tương ứng, một cửa sổ bật lên mới sẽ xuất hiện hiển thị thông báo “Tạo vênh vang có thể mất vài giây“. Vì việc tạo đặc tả OpenAPI có thể mất một chút thời gian tùy thuộc vào độ phức tạp của chính API. Khi bạn đã sẵn sàng, chỉ cần nhấp vào “Tạo Swagger cho ứng dụng này” để truy cập vào giao diện người dùng Swagger.

Nếu trước đây bạn đã tạo Swagger cho một ứng dụng, việc nhấp vào biểu tượng Swagger sẽ mở ra một cửa sổ bật lên cung cấp cho bạn tùy chọn hiển thị Swagger hiện tại hoặc làm mới nó để tạo một Swagger mới. Điều này đặc biệt hữu ích nếu các thay đổi đã được thực hiện đối với API kể từ lần cuối cùng Swagger được tạo.

Cửa sổ bật lên cũng hiển thị lần cuối cùng Swagger được cập nhật, giúp bạn theo dõi tính hợp lệ của Swagger và có thể đặc biệt hữu ích đối với các API lớn được cập nhật thường xuyên.

Ví dụ: giả sử bạn đã thực hiện một số thay đổi đối với LabCollector Các điểm cuối API, chẳng hạn như thêm hoặc sửa đổi các tham số và bạn muốn đảm bảo rằng Swagger phản ánh chính xác những thay đổi này. Trong trường hợp đó, bạn chỉ cần làm mới Swagger bằng cách nhấp vào nút làm mới và Swagger mới sẽ được tạo với thông tin cập nhật.

1. Làm cách nào để kiểm tra điểm cuối API?

Khi bạn đã tạo Swagger cho ứng dụng đã chọn, bạn sẽ tự động được chuyển hướng đến giao diện Swagger UI, giao diện này hiển thị danh sách các điểm cuối API có sẵn ở phía bên trái màn hình (như được hiển thị trong ảnh chụp màn hình bên dưới). Giao diện thân thiện với người dùng này cho phép bạn dễ dàng khám phá các khả năng của API, kiểm tra nó và tạo tài liệu dựa trên đặc tả OpenAPI.

Sau đó, nhấp vào điểm cuối để xem chi tiết, bao gồm các tham số và phản hồi mà nó trả về. Trong ví dụ của chúng tôi, chúng ta có thể thấy tất cả các mô-đun và điểm cuối tương ứng của chúng, cùng với mô tả ngắn gọn về hành động của chúng. Ví dụ, chúng ta có thể thấy rằng NHẬN/chủng hoạt động để lấy các bản ghi từ mô-đun Chủng & Tế bào, POST/chủng hoạt động bằng cách thêm các bản ghi vào cùng một mô-đun… v.v.

Để kiểm tra điểm cuối, hãy nhấp vào “Dùng thửNút ” và nhập các thông số cần thiết (như trong ảnh chụp màn hình bên dưới). Điều này đặc biệt hữu ích khi phát triển và thử nghiệm các điểm cuối mới trước khi tích hợp chúng vào ứng dụng của bạn.

Cuối cùng, khi bạn đã nhập tất cả các tham số của mình, hãy nhấp vào “Thực hiệnNút ” để gửi yêu cầu tới API và xem phản hồi.

Sau đó, bạn có thể xem kết quả yêu cầu của mình, cùng với tất cả các yêu cầu xấu/trái phép/bị cấm nếu có.

Hơn nữa, Giao diện người dùng Swagger cho phép bạn tạo tài liệu tự động dựa trên đặc tả OpenAPI. Tài liệu này có thể được tải xuống ở nhiều định dạng khác nhau, chẳng hạn như PDF hoặc JSON và có thể được sử dụng để truyền đạt khả năng của API tới các nhà phát triển khác.