0xironclad / 0xironclad/Task-Scheduler-API
Add OpenAPI spec
Đang mở
api
docs
- Ngôn ngữ chính
- TypeScript
- Star
- 0
- Fork
- 2
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
Document endpoints, payloads, and error shapes in a `openapi.yaml`. Optional Swagger UI.
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Hướng nghiên cứu
Kiểm tra các route Express hiện có trong codebase để hiểu các endpoint, payload yêu cầu/phản hồi và định dạng lỗi. Tạo một tệp openapi.yaml để ghi chép lại chúng. Tùy chọn, tích hợp một gói Swagger UI để phục vụ đặc tả. Xác minh rằng đặc tả khớp với hành vi API thực tế bằng cách kiểm tra các endpoint.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- express, node.js, openapi, typescript
- Lĩnh vực
- api, documentation
- Loại issue
- Tài liệu
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 55/100