[Request] Auto-generated, publicly accessible API docs

Đang mở
#838 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
typescript
Lĩnh vực
api, documentation

Hướng nghiên cứu

Bắt đầu bằng việc xem xét gist tài liệu API hiện có được liên kết trong issue, sau đó lập danh sách các endpoint hiện tại để truy xuất và tạo dữ liệu, cũng như để phát hành lệnh. Xác định vị trí công khai của tài liệu được tạo và xác minh rằng tài liệu bao quát các nhóm endpoint đó cho các nhà phát triển Farmware và tích hợp.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Currently https://gist.github.com/RickCarlino/10db2df375d717e9efdd3c2d9d8932af exists but it would be very useful to have a, for example, https://api.farm.bot that detailed the available endpoints for data retrieval, creation, and issuing commands would be very useful for farmware and integration developers.

If something like this already exists please point me to it and close this ticket.

Ngôn ngữ chính
TypeScript
Star
978
Fork
357
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của FarmBot/Farmbot-Web-App

Tất cả issue của FarmBot/Farmbot-Web-App

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.