Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

API: Link pages to API counterparts

Đang mở
  • Có gì không ổn?
#647 0 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
30/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
php
Lĩnh vực
api, backend, web-dev

Hướng nghiên cứu

Bắt đầu bằng cách lần theo các hàm go hiện có của API endpoint, các hàm go/do của page và luồng DocumentBinder được mô tả trong issue. Xác định cách một thuộc tính AutoApiPage ánh xạ một page với một API endpoint và cách các hàm do của POST hoặc PUT được chọn. Hoàn thành khi dữ liệu API tương đương có thể được bind vào các page, đồng thời vẫn cho phép thao tác bổ sung trên page và xử lý form.

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

Mô tả

A very common web development technique is to design an API first, and then link it to the "front end" via lots of slow ajax calls.

This technique can still be achieved in WebEngine, but because WebEngine is completely server-side, this can be handled automatically.

For example, the following API endpoints can be created:

  • api/index - index API will list countries
  • api/@country-name e.g. /morocco - list cities within country
  • api/@country-name/@city-name e.g. /morocco/rabat - list places within city
  • api/@country-name/@city-name/@place-name e.g. /morocco/rabat/national-zoo - show details on place

Once the API endpoints are created, the application's data can be used in other applications, but what if we then wanted to provide a web interface to the data, too?

It would make sense to have the pages follow the same URL structure:

  • page/index
  • page/@country-name
  • page/@country-name/@city-name
  • page/@country-name/@city-name/@place-name

These pages will use HTML to structure the content, with data-bind attributes to indicate where the data should be bound.

The PHP should not need to "build" the data up again, because this is already done within the API's PHP logic files. Instead, the go function could be marked with an attribute #[AutoApiPage] or something similar. The presence of this attribute will automatically grab the data that an equivalent API call would respond with, and automatically performs a bind operation to the DocumentBinder. Pages might not have the exact same URL as their API counterparts, so the API endpoint can be passed into the attribute, like #[AutoApiPage("/@country-name/@city-name") for example.

Then, if more manipulation is required to the page, this can be done in the go function as usual.

Submitting a form on a page will trigger a do function. Hooking a do function to the AutoApiPage attribute will call it as a POST request, but if there's multiple do functions on the page - one for updating, one for creating, the HTTP method can be passed in as a parameter like #[AutoApiPage(HttpMethod::PUT)]. Using type juggling, these attribute parameters should be able to be passed in any order.

Ngôn ngữ chính
PHP
Star
26
Fork
6
Merge trung bình
21 ngày 17 giờ
Pull request đã merge (30 ngày)
1

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 phpgt/WebEngine

Tất cả issue của phpgt/WebEngine

Issue tương tự

Thêm issue về PHP

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.