Nhập OpenAPI / Swagger
Đây là phần nhập đầy đủ nhất của Restorm. Ba phiên bản được nhận diện: Swagger 2.0, OpenAPI 3.0 và OpenAPI 3.1.
Tệp ▸ Nhập (Ctrl+I), rồi chọn một tệp swagger.json / openapi.json,
hoặc trực tiếp URL của đặc tả.
Nếu URL trả về 401 hoặc 403, Restorm sẽ đề nghị bạn gắn một cơ chế xác thực
rồi thử lại, mà không phải rời khỏi hộp thoại nhập.
Những gì được nhập
Section titled “Những gì được nhập”| Phần tử của đặc tả | Restorm biến nó thành gì |
|---|---|
servers (hoặc host + basePath + schemes) | URL cơ sở của môi trường, với các biến máy chủ đã giải quyết |
tags | Một thư mục cho mỗi nhãn, cộng thêm một thư mục Other cho phần còn lại |
| Mỗi thao tác | Một yêu cầu HTTP, bao gồm cả phương thức và đường dẫn |
| Tham số | Tham số đường dẫn, tham số truy vấn và header, có kiểu (chuỗi, số, ngày-giờ, kiểu liệt kê, bí mật…) |
requestBody | Phần thân, theo kiểu nội dung của nó |
examples | Phần thân được điền sẵn bằng ví dụ được cung cấp |
components / definitions | Tài liệu API: mô hình, mô tả |
enum | Các kiểu liệt kê tái sử dụng được như một kiểu giá trị |
| Phản hồi | Được ghi thành tài liệu theo từng kiểu nội dung |
Các $ref đều được giải quyết, kể cả xuyên qua các component.
Dòng components / definitions đáng được nhấn mạnh: phần nhập không chỉ dừng
ở các yêu cầu, nó còn giữ lại toàn bộ tài liệu của API — mô tả, mô hình, sơ
đồ bảo mật, ví dụ, kiểu liệt kê. Tài liệu này xem được trong tab Docs của
thư mục biến sinh ra từ lần nhập, cũng như trong tab Docs của từng yêu cầu, và
nó được đồng bộ lại từ nguồn. Xem
Truy cập và cập nhật tài liệu của một API đã nhập.
Bảo mật
Section titled “Bảo mật”Các sơ đồ bảo mật được khai báo sẽ được chuyển thành header hoặc tham số đấu nối sẵn, kèm biến môi trường tương ứng được tạo giúp bạn:
| Sơ đồ | Những gì Restorm đặt ra |
|---|---|
apiKey ở header hoặc ở truy vấn | Một cặp đặt tên theo sơ đồ, giá trị {{<schema>}} |
http + basic | Authorization: Basic {{<schema>_credentials}} |
http + bearer, oauth2, openIdConnect | Authorization: Bearer {{<schema>_token}} |
Bạn chỉ còn phải điền giá trị cho biến — hoặc thay nó bằng một tuyến xác thực để có được cơ chế tự động gia hạn.
Cập nhật
Section titled “Cập nhật”OpenAPI và Swagger nằm trong số các định dạng đồng bộ lại được: nút Làm mới của thư mục sẽ lấy lại nguồn và Restorm áp dụng phần khác biệt — các thao tác mới được thêm vào, các thao tác đã biến mất được đánh dấu lỗi thời thay vì bị xóa, còn các sửa đổi của bạn được giữ nguyên. Xem Cập nhật từ nguồn.