Include dev API in docs
Đang mở
Chưa có ai nhận issue này.
cloud/server
- Ngôn ngữ chính
- Vue
- Star
- 15
- Fork
- 22
- Merge trung bình
- 5 ngày 11 giờ
- Pull request đã merge (30 ngày)
- 9
Mô tả
if we have swagger definition of the public REST API it should be possible to easily create nice documentation for anyone who would like to use it for custom integrations
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Issue xác định REST API công khai và một định nghĩa Swagger, nhưng không nêu tên tệp hoặc điểm vào nào. Hãy bắt đầu bằng việc xác định đặc tả API và các điểm tích hợp của trang web tài liệu; hoàn thành có nghĩa là API công khai được tài liệu hóa dưới dạng dễ sử dụng cho các bên tích hợp tùy chỉnh.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- openapi
- Lĩnh vực
- api, documentation
- Loại issue
- Tài liệu
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 25/100