maira-cli
MairaCLI là một công cụ dành cho nhà phát triển được thiết kế để tự động tạo tài liệu swagger cho các điểm cuối bằng cách chặn các yêu cầu và phản hồi trong khi thử nghiệm các điểm cuối API.
Liệt kê trong các danh mục:
Công cụ phát triểnDanh mụcMã nguồn mở
Mô tả
MairaCLI là một công cụ dành cho nhà phát triển được thiết kế để tự động tạo tài liệu Swagger cho các điểm cuối API bằng cách chặn các yêu cầu và phản hồi trong quá trình thử nghiệm.
Cách sử dụng maira-cli?
Để sử dụng MairaCLI, hãy cài đặt nó qua npm, khởi động máy chủ proxy trong dự án backend của bạn, cấu hình các chi tiết cần thiết trong tệp config.json và thực hiện các yêu cầu đến backend của bạn thông qua máy chủ proxy. Sau khi thực hiện các yêu cầu, hãy tạo tài liệu bằng cách sử dụng lệnh được cung cấp.
Tính năng chính của maira-cli:
1️⃣
Tự động tạo tài liệu Swagger cho các điểm cuối API
2️⃣
Chặn các yêu cầu và phản hồi để có tài liệu chính xác
3️⃣
Tạo các tệp cấu hình cho các tuyến đường của dự án
4️⃣
Tạo liên kết xem trước tài liệu
5️⃣
Hỗ trợ các tiêu đề xác thực tùy chỉnh
Tại sao nên sử dụng maira-cli?
| # | Trường hợp sử dụng | Trạng thái | |
|---|---|---|---|
| # 1 | Tạo tài liệu API cho các dự án backend | ✅ | |
| # 2 | Thử nghiệm các điểm cuối API trong khi tài liệu hóa chúng | ✅ | |
| # 3 | Tạo tài liệu Swagger cho các microservices | ✅ | |
Do ai phát triển maira-cli?
MairaCLI được phát triển bởi một cộng đồng các nhà đóng góp trên GitHub, nhằm đơn giản hóa quy trình tài liệu API cho các nhà phát triển.