Nhập một API

Restorm nhận diện hai mươi bốn định dạng và từ đó dựng lại một cây dự án đầy đủ: thư mục, yêu cầu, môi trường, tài liệu API, kiểu liệt kê.

Đây gần như luôn là điểm khởi đầu tốt nhất: đừng viết tay các yêu cầu của bạn nếu đã có sẵn một đặc tả.

Nhập như thế nào

Tệp ▸ Nhập (Ctrl+I) chấp nhận:

• một tệp trên ổ đĩa;
• một URL — hữu ích cho một swagger.json hay một $metadata được phục vụ trực tuyến;
• nội dung dán vào — đây là cách biến một lệnh curl thành một yêu cầu.

Restorm tự phát hiện định dạng: trước hết theo phần mở rộng của tệp, sau đó bằng cách phân tích nội dung. Bạn không phải chọn gì cả.

Các định dạng

Đặc tả API

Định dạng	Trang
OpenAPI 3.x và Swagger 2.0	OpenAPI / Swagger
Schema GraphQL (SDL)	GraphQL
Tệp .proto và phản chiếu gRPC	gRPC
WSDL	SOAP / WSDL
AsyncAPI	AsyncAPI
OData EDMX / CSDL	OData
OpenRPC	OpenRPC
Schema tRPC	tRPC
Smithy	Smithy
TypeSpec	TypeSpec
RAML	RAML
WADL	WADL
Thrift	Thrift
API Blueprint	API Blueprint

Bộ sưu tập của các client khác

Định dạng	Trang
Postman	Postman
Insomnia	Insomnia
Bruno	Bruno
Thunder Client	Thunder Client
Paw / RapidAPI	Paw
HTTPie	HTTPie
VS Code REST Client (.http)	REST Client

Bản ghi và dòng lệnh

Định dạng	Trang
HAR (bản ghi từ trình duyệt)	HAR
Lệnh curl	cURL
Invoke-RestMethod / Invoke-WebRequest	PowerShell

Bạn nhận được gì

Tùy theo mức độ phong phú của định dạng nguồn:

• một thư mục biến với một hoặc nhiều môi trường, kèm URL cơ sở trích ra từ đặc tả;
• một cây thư mục — theo nhãn, theo dịch vụ, theo tài nguyên tùy định dạng;
• một yêu cầu cho mỗi thao tác, thuộc kiểu tương ứng với giao thức;
• tài liệu API gắn với thư mục: mô hình, mô tả, sơ đồ bảo mật, phản hồi ví dụ;
• các kiểu liệt kê của đặc tả, tái sử dụng được như một kiểu giá trị;
• các header xác thực đã đấu nối sẵn cùng với biến của chúng — xem Xác thực.

Sau khi nhập, mọi cặp khóa / giá trị mà giá trị giải quyết ra rỗng sẽ tự động bị vô hiệu hóa: nhờ vậy lần gửi đầu tiên của bạn không kéo theo cả đám header rỗng.

Tài liệu của API đã nhập

Một lần nhập không chỉ tạo ra yêu cầu: nó còn giữ lại tài liệu của API — mô tả, mô hình, phần bảo mật, ví dụ, kiểu liệt kê — xem được trong tab Docs của thư mục vừa tạo. Xem Truy cập và cập nhật tài liệu của một API đã nhập.

Cập nhật một lần nhập

Mười hai định dạng chấp nhận việc đồng bộ lại: Restorm so sánh phiên bản mới của nguồn với cây hiện có rồi áp dụng phần khác biệt, mà không làm mất các sửa đổi của bạn. Xem Cập nhật từ nguồn.

Còn phần xuất thì sao?

Restorm sinh ra đoạn mã cho mỗi yêu cầu, trong mọi ngôn ngữ phù hợp với giao thức của nó. Xem Xuất mã.