API MediaWiki là một bộ công cụ phát triển được ghi chép đầy đủ có thể thực hiện phần lớn các tác vụ trong một tập lệnh. API thường được sử dụng để phát triển các công cụ tự động để sử dụng trong wiki. API MediaWiki có thể được sử dụng dễ dàng bởi hầu hết các ngôn ngữ, đặc biệt là PHP (Các hàm curl) cũng như Perl và một số ngôn ngữ khác..
Các bước
Bước 1. Đọc tài liệu API MediaWiki
Nó nằm ở 'api.php' trong cùng thư mục với index.php thông thường. Ví dụ:
Bước 2. Chọn một định dạng đầu ra
MediaWiki cung cấp đầu ra dữ liệu ở dạng JSON, JSONFM, PHP (định dạng tuần tự hóa), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM và RAWFM. Các định dạng có hậu tố "FM" được in khá đẹp trong HTML.
Bước 3. Chọn một hành động
API MediaWiki hỗ trợ các hành động sau:
- trợ giúp - Xem màn hình trợ giúp
- đăng nhập - Đăng nhập vào MediaWiki
- opensearch - Triển khai giao thức tìm kiếm mở. (Không phải tất cả các cài đặt MediaWiki đều có điều này).
- feedwatchlist - Trả lại nguồn cấp dữ liệu danh sách theo dõi.
- truy vấn - Có nhiều tùy chọn. Xem tài liệu API MediaWiki để biết chúng.
Bước 4. Chọn một truy vấn hoặc một danh sách
Bên cạnh các hành động tiêu chuẩn, MediaWiki hỗ trợ các truy vấn và danh sách khác nhau, chẳng hạn như liệt kê các trang có chứa liên kết đến một bài viết khác, số lượng các thay đổi gần đây khác, đóng góp, v.v.
Bước 5. Chuyển dữ liệu đã đăng tới API thông qua việc sử dụng CURL hoặc một công cụ khác cho phép bạn sử dụng phương thức POST cho tập lệnh
Phương thức GET cũng có thể hoạt động.
Bước 6. Đảm bảo giữ cookie được gửi đến một ứng dụng (Một số tập lệnh / ứng dụng có thể muốn lưu trữ nó trong một thư mục con
Bước 7. Khi tương tác với giao diện người dùng MediaWiki, hãy nhớ mã thông báo chỉnh sửa của bạn được giữ trong hầu hết các trang chỉnh sửa
Mã chỉnh sửa được sử dụng để xác định các va chạm chỉnh sửa và tránh ghi đè một chỉnh sửa khác đã được thực hiện (Điều này cũng được sử dụng trong quá trình khôi phục.). Hãy nhớ rằng mọi thứ sẽ trở nên tồi tệ hơn nếu bạn đang làm việc với giao diện người dùng của wiki. Hãy lưu ý đến bất kỳ regex nào bạn sử dụng để đảm bảo rằng chúng sẽ chỉ mang lại kết quả như mong muốn.
Bước 8. Đọc kết quả do wiki gửi đến
Kết quả sẽ được gửi cho bạn trong một phản hồi HTTP, có thể được đọc bởi nhiều trình phân tích cú pháp. Cẩn thận hơn với định dạng bạn chọn. Đảm bảo rằng bạn sử dụng trình phân tích cú pháp thích hợp cho định dạng đó. Thông thường, bạn nên ghi rõ định dạng cho MediaWiki ngay cả khi nó có định dạng mặc định mà bạn muốn sử dụng.
Lời khuyên
- Đảm bảo rằng bạn có wiki địa phương hỗ trợ tập lệnh trước khi sử dụng API.
- Bạn có thể tìm thêm về MediaWiki bằng cách sử dụng API của nó.
