Write a guide how to implement an API Report method
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 45/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- php
- Lĩnh vực
- api, documentation
Hướng nghiên cứu
Bắt đầu với hướng dẫn Exposing API Methods hiện có được liên kết trong issue. Thêm các ví dụ bao gồm một DataTable được xây dựng từ một mảng đơn giản và một report hiện có được tùy chỉnh bằng một bộ lọc, đồng thời giải thích cách áp dụng các tham số truy vấn DataTable như limit, showColumns và filter_*; hướng dẫn được hoàn thành khi cả hai ví dụ và phần giải thích lý do đó được ghi lại.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
It would be good to extend the current guide about Exposing API Methods with an example how to implement an API Report method.
Maybe one example that creates a DataTable from a simple array and runs a filter on it? The filter is maybe not needed but we should explain why not simply return the plain array: Because the dataTable allows to use all our query parameters like limit, showColumns, filter_*, ...
Then maybe another simple example that fetches an existing report, runs a filter on it to customize the report and returns it.
- Ngôn ngữ chính
- PHP
- Star
- 58
- Fork
- 88
- Merge trung bình
- 2 ngày 10 giờ
- Pull request đã merge (30 ngày)
- 2
Chuẩn bị môi trường
Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.
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.
Issue khác của matomo-org/developer-documentation
-
Documentation enhancement
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 68/100
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 45/100
-
bug
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 55/100
matomo-org/developer-documentation#806 · 2 bình luận ·
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100
matomo-org/developer-documentation#787 · 1 bình luận ·
Tất cả issue của matomo-org/developer-documentation
Issue tương tự
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
backdrop-contrib/print#58 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
laravel/nova-issues#7008 ·
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
FriendsOfFlarum/badges#20 ·
-
[Dashboard Redesign] Support and Documentation links should warn they'll be opened in another tabĐang mởModule: dashboard type: enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
Maintainer thường phản hồi trong vòng 1 ngày