Ghi chú. Trình tạo API không còn được duy trì. Cơ sở mã này vẫn hoạt động nhưng sẽ không nhận được bản cập nhật. Nếu bạn quan tâm đến việc duy trì dự án xin vui lòng cho tôi biết [23-5-2016]
Trình tạo API PHPDễ dàng chuyển đổi các bảng MySQL thành các API JSON có thể truy cập trên web bằng thư viện mini dành cho PHP này
Bắt đầu. Tùy chỉnh API của bạn. Yêu cầu. Sử dụng dữ liệu. Gửi dữ liệu của bạn. Tham chiếu tham số API
Bắt đầu
Trình tạo API PHP này được sử dụng để xây dựng các API JSON http đơn giản từ cơ sở dữ liệu MySQL. Với nó, bạn [hoặc bất kỳ ai nếu bạn chọn công khai API] có thể truy cập dữ liệu trên web thông qua trang
$api->set_key_required[true];0 dễ thiết lập. Sử dụng Tham số API được cung cấp trong thư viện nhỏ này, người dùng có thể truy vấn cơ sở dữ liệu thông qua trang
$api->set_key_required[true];0 đó bằng cách sử dụng tham số
$api->set_key_required[true];2 có trong URL của yêu cầu và trả về kết quả dưới dạng JSON hợp lệ. Danh sách đầy đủ các tham số API có sẵn nằm trong phần Tham chiếu tham số API của tài liệu này
Làm thế nào nó hoạt động
Thiết lập API thật dễ dàng. Để thêm API vào bảng MySQL hiện có, chỉ cần đặt thư mục
$api->set_key_required[true];3 và tệp
$api->set_key_required[true];4 của kho lưu trữ này vào thư mục nơi bạn muốn đặt trang api của mình [Nếu bạn muốn api của mình có thể truy cập được tại yourdomain. com/api. php, bạn nên đặt các tệp này trong thư mục gốc của mình]. Tiếp theo cập nhật tệp
$api->set_key_required[true];4 để phản ánh thông tin cơ sở dữ liệu và tùy chỉnh API mong muốn của bạn. Sau đó, lưu tệp đã cập nhật dưới dạng
$api->set_key_required[true];0 hoặc bất kỳ thứ gì bạn muốn trang API của mình được gọi
Đó là nó. Giờ đây, bạn có thể truy cập dữ liệu từ cơ sở dữ liệu MySQL của mình bằng Tham số URL của Trình tạo API. Dưới đây là một ví dụ cơ bản về cách thiết lập đối tượng
$api->set_key_required[true];7
Tải xuống
Bạn có thể tải trực tiếp một. zip của Trình tạo API bằng cách nhấp vào đây. Thư viện nhỏ API Builder đã được xây dựng và thử nghiệm bằng PHP 5. 4. 4 và kết quả khi sử dụng các phiên bản PHP cũ hơn không xác định
Thí dụ
Trong suốt tài liệu tham khảo này, một cơ sở dữ liệu ví dụ sẽ được sử dụng. Bảng ví dụ này, có tên là
$api->set_key_required[true];8, chứa thông tin về những người dùng tưởng tượng thuộc về một tổ chức.
$api->set_key_required[true];0 cho ví dụ này như sau
$api->set_key_required[true];0
Sử dụng
$api->set_key_required[true];4 để tạo api của riêng bạn
Tùy chỉnh API của bạn
Thư viện nhỏ API Builder có nhiều thiết lập API phức tạp hơn so với thiết lập được trình bày trong tệp
$api->set_key_required[true];4. Một số tính năng này bao gồm
- Đặt API ở chế độ Riêng tư để chỉ bạn mới có thể truy cập dữ liệu mà nó cung cấp
- Sử dụng các khóa API để theo dõi và giới hạn mức sử dụng số lần truy cập mỗi ngày đối với những người dùng cụ thể
- Và đặt mặc định API cho số lượng kết quả trả về cho mỗi yêu cầu, thứ tự trả về kết quả mặc định, v.v…
Tất cả các phương thức thiết lập lớp
$api->set_key_required[true];32 [không bao gồm hàm tạo] đều bắt đầu bằng từ
$api->set_key_required[true];33. Bạn có thể xem danh sách đầy đủ các phương pháp thiết lập này và mô tả ngắn gọn bên dưới. Để biết thêm thông tin về từng phương pháp, hãy xem nguồn
$api->set_key_required[true];34
Phương pháp thiết lập lớp API
Các tên in đậm biểu thị các phương thức được yêu cầu sử dụng khi xây dựng API. Tất cả các phương pháp khác là tùy chọn
$api->set_key_required[true];
35 Khởi tạo đối tượng API và tạo kết nối cơ sở dữ liệu MySQLi$api->set_key_required[true];
36 cho đối tượng API biết giá trị cột nào sẽ sử dụng khi xuất đối tượng kết quả. Tham số$api->set_key_required[true];
37 là danh sách tên cột được phân cách bằng dấu phẩy tương ứng với tên cột trong cơ sở dữ liệu của bạn$api->set_key_required[true];
38 đặt cột mặc định cho api để sắp xếp kết quả nếu không có tham số 'order_by' nào được chỉ định trong yêu cầu$api->set_key_required[true];
39 đặt luồng mặc định nếu không có luồng nào được chỉ định trong yêu cầu$api->set_key_required[true];
10 đặt số lượng đối tượng kết quả JSON mà mỗi yêu cầu API sẽ xuất ra nếu không có tham số 'giới hạn' nào được đưa vào yêu cầu$api->set_key_required[true];
11 đặt số đối tượng kết quả JSON tối đa được phép cho mỗi yêu cầu$api->set_key_required[true];
12 đặt đầu ra JSON mặc định là định dạng có thể đọc được của con người$api->set_key_required[true];
13 bật tham số 'tìm kiếm' API và chỉ định cột nào có thể được tìm kiếm. Một lần nữa, tham số$api->set_key_required[true];
37 là danh sách tên cột được phân cách bằng dấu phẩy tương ứng với tên cột trong cơ sở dữ liệu của bạn. Chỉ các cột Văn bản đã được lập chỉ mục FULLTEXT mới có thể được đưa vào danh sách cột$api->set_key_required[true];
15 đặt các cột mặc định cho API để sắp xếp các kết quả tham số 'tìm kiếm' của API nếu câu lệnh MySQL FULLTEXT Match[]…Against[]… được thực thi ở chế độ boolean [chỉ bắt buộc nếu$api->set_key_required[true];
16 đã cho phép tìm kiếm các cột]$api->set_key_required[true];
17 bật thông số [API 'loại trừ']. Tham số của phương thức này chỉ có thể là$api->set_key_required[true];
18 nếu bảng cơ sở dữ liệu của bạn bao gồm cột 'id' [hoặc bất kỳ tên cột duy nhất nào được bao gồm làm tham số tùy chọn của phương thức này]$api->set_key_required[true];
19 làm cho API của bạn yêu cầu một khóa duy nhất cho mỗi yêu cầu. Để biết thêm thông tin về việc hạn chế và theo dõi người dùng API, hãy truy cập phần Bảo vệ API của bạn trong tài liệu này$api->set_key_required[true];
10 đặt số lần truy cập API cho mỗi khóa API mỗi ngày$api->set_key_required[true];
11 đặt API ở chế độ riêng tư [i. e. chỉ bạn mới có thể sử dụng nó]. Để biết thêm thông tin về phương pháp này, hãy truy cập phần Bảo vệ API của bạn trong tài liệu này$api->set_key_required[true];
12 đặt thông báo lỗi khi không tìm thấy kết quả nào trong một yêu cầu
Nếu thiết lập API được định cấu hình không chính xác, đối tượng phản hồi JSON kết quả của
$api->set_key_required[true];0 sẽ chứa một mảng thông báo
$api->set_key_required[true];14 mô tả lỗi thay vì thuộc tính
$api->set_key_required[true];15
Các phương pháp khác
Ngoài các phương pháp thiết lập API, còn có một vài phương pháp khác có thể hữu ích khi biết
$api->set_key_required[true];
16 trả về kết quả API dưới dạng JSON từ một mảng kết hợp của Tham số trình tạo API. Đây là cách bạn thực sự in kết quả API ra trình duyệt
Và từ lớp
$api->set_key_required[true];17 tĩnh
$api->set_key_required[true];
18 tạo kết nối cơ sở dữ liệu. Phương thức tĩnh này được gọi từ bên trong$api->set_key_required[true];
19, vì vậy nếu bạn đã khởi tạo một đối tượng API, bạn không cần sử dụng phương thức tĩnh này trừ khi cơ sở dữ liệu đã bị đóng$api->set_key_required[true];
10 đóng kết nối cơ sở dữ liệu MySQLi$api->set_key_required[true];
11 thực thi câu lệnh MySQL được cung cấp làm tham số của nó và trả về một giá trị boolean biểu thị thành công của nó$api->set_key_required[true];
12 trả về một mảng 2D của bảng kết quả từ chuỗi truy vấn MySQL được truyền dưới dạng tham số$api->set_key_required[true];
13 mã hóa tham số bằng cách sử dụng$api->set_key_required[true];
14 và$api->set_key_required[true];
15 và trả về chuỗi đã được làm sạch. Hữu ích cho việc khử trùng đầu vào trước khi đưa nó vào cơ sở dữ liệu$api->set_key_required[true];
16 chèn các hàng vào [hoặc cập nhật các hàng hiện có nếu sử dụng tham số tùy chọn] cơ sở dữ liệu từ $assoc_array trong đó tất cả các khóa trong mảng là tên cột của giá trị của chúng trong $table_name. Tên bảng có thể được truy cập thông qua thuộc tính công khai tĩnh$api->set_key_required[true];
17
Ghi chú. Tất cả các phương thức lớp
$api->set_key_required[true];17 là tĩnh
Để biết thêm thông tin về hoặc chính thư viện nhỏ, bạn có thể đọc mã nguồn. Sắp có thêm nhiều ví dụ, đặc biệt là về cách cập nhật cơ sở dữ liệu của bạn mà bạn nghĩ là
$api->set_key_required[true];2 hoặc
$api->set_key_required[true];10 bằng cách sử dụng
$api->set_key_required[true];11
Bảo vệ API của bạn
Có hai cách để giới hạn quyền truy cập vào API của bạn bằng các phương pháp thiết lập. Cách đầu tiên và riêng tư nhất là thiết lập API của bạn để chỉ bạn [và những người bạn cung cấp khóa riêng] mới có thể truy cập được. Thứ hai là theo dõi và giới hạn việc sử dụng API bằng các khóa API được phân phối cho người dùng của bạn
Đặt API của bạn ở chế độ riêng tư
Để đặt API của bạn ở chế độ riêng tư, hãy bao gồm những điều sau đây khi thiết lập trang
$api->set_key_required[true];0 của bạn trong đó
$api->set_key_required[true];13 là một SHA1 40 ký tự duy nhất
$api->set_key_required[true];5
Sau đó, khi bạn thực hiện một yêu cầu http cho API của mình, chỉ cần thêm khóa riêng của bạn vào yêu cầu bằng cách sử dụng Tham số khóa riêng của API
$api->set_key_required[true];6
Viola… API riêng của bạn
Hạn chế và theo dõi việc sử dụng bằng các khóa API
Thông thường, chủ sở hữu API cung cấp cho người dùng các khóa API duy nhất để theo dõi và giới hạn các yêu cầu để không làm chậm máy chủ. Đây là một thực tế phổ biến với các API của Google, Twitter và Facebook. Trình tạo API cho phép chủ sở hữu API dễ dàng làm điều tương tự
Thiết lập cơ sở dữ liệuVì quy trình này yêu cầu mỗi người dùng phải có khóa API duy nhất của riêng họ để truy cập API, nên cần tạo một bảng mới để lưu trữ thông tin về những người dùng sẽ thực hiện yêu cầu. Bảng này phải được đặt tên là "người dùng" và phải bao gồm ít nhất các cột sau. "id", "API_key", "API_hits" và "API_hit_date". Các tên bảng và cột này phải chính xác trừ khi được chỉ định khác bằng cách sử dụng các tham số tùy chọn của
$api->set_key_required[true];14 [xem thiết lập API bên dưới]. Cấu trúc bảng SQL này có thể được nhập vào cơ sở dữ liệu hiện có của bạn từ tệp
$api->set_key_required[true];15
Ngoài ra, thường xảy ra trường hợp các API thực sự mô tả dữ liệu liên quan đến người dùng ngay từ đầu. Chẳng hạn, các API của Twitter và Facebook cung cấp dữ liệu về người dùng. Nếu API của bạn đang phân phối dữ liệu từ bảng người dùng và bạn chỉ muốn cấp cho những người dùng đó quyền truy cập vào API của mình, bạn có thể chỉ cần thêm các cột "id", "API_key", "API_hits" và "API_hit_date" vào
Thiết lập APIKhi bảng mới đã được tạo trong cơ sở dữ liệu của bạn [hoặc bảng gốc lưu người dùng đã được sửa đổi để bao gồm các cột bắt buộc], bạn đã sẵn sàng thiết lập API của mình để theo dõi và giới hạn số lần truy cập của người dùng. Nếu bạn đã sử dụng tên bảng mặc định là "người dùng" và tên cột "id", "API_key", "API_hits" và "API_hit_date" thì việc thiết lập API sẽ dễ dàng
$api->set_key_required[true];
Nếu bạn chọn thay đổi tên của bảng hoặc bất kỳ cột nào thì những thay đổi này phải được chỉ định bằng cách sử dụng các tham số tùy chọn của ________ 514
$api->set_key_required[true];3
Ví dụ: nếu bạn chọn không thêm bảng "người dùng" mới vào cơ sở dữ liệu của mình vì bảng được sử dụng cho API, "fakeorganization_users", đã lưu trữ những người dùng mà bạn muốn cấp quyền truy cập vào API [như trong trường hợp của Twitter hoặc
$api->set_key_required[true];1
Nếu bạn cũng đã thay đổi tên cột "API_hits" thành "number_of_hits_today" thì thiết lập khóa API của bạn sẽ là
$api->set_key_required[true];1
Ghi chú. Đừng quên chỉ định tên bảng hoặc cột không thay đổi là
$api->set_key_required[true];17 để duy trì thứ tự tham số
Để đơn giản, bạn nên tải xuống và nhập cấu trúc bảng "người dùng" mà không sửa đổi tên cột
Tất cả những gì cần thiết bây giờ là bạn điền "API_key" của bảng "người dùng" bằng SHA1 40 ký tự và phân phối chúng cho người dùng ngoài đời thực của bạn để họ có thể sử dụng API của bạn
Khi API của bạn đã được đặt để yêu cầu khóa [
$api->set_key_required[true];14], chỉ những người dùng thực hiện yêu cầu http có chứa Thông số khóa API hợp lệ mới nhận được kết quả API
$api->set_key_required[true];1
Trong ví dụ trên, bảng "người dùng" phải bao gồm một hàng người dùng trong đó giá trị của "API_key" [hoặc cột tương đương của API của bạn] là "1278cf264faca856baf2268e52e2761a75972ec7". Trong trường hợp không đúng như vậy, một khóa không hợp lệ được cung cấp hoặc không có khóa nào được cung cấp, thuộc tính
$api->set_key_required[true];19 sau đây được trả về trong đối tượng JSON phản hồi thay vì một mảng
$api->set_key_required[true];15
$api->set_key_required[true];1
Trong trường hợp người dùng đã sử dụng tối đa số lần truy cập API của họ trong ngày [được đặt bằng cách sử dụng
$api->set_key_required[true];01], API sẽ trả về thông tin sau
$api->set_key_required[true];0
Yêu cầu
Sử dụng API của bạn thật dễ dàng khi bạn tìm hiểu cách thức hoạt động của nó
Định dạng một yêu cầu
Trình tạo API truy vấn Cơ sở dữ liệu MySQL và do đó, các yêu cầu http được sử dụng để trả về dữ liệu rất giống với việc tạo câu lệnh truy vấn MySQL
$api->set_key_required[true];02. Nếu bạn đã từng sử dụng MySQL trước đây, hãy nghĩ đến việc sử dụng các tham số URL API dưới dạng các phần nhỏ của truy vấn. Chẳng hạn, các tham số
$api->set_key_required[true];03,
$api->set_key_required[true];04 và
$api->set_key_required[true];05 [biệt danh của tôi dành cho
$api->set_key_required[true];07 hoặc
$api->set_key_required[true];08 của MySQL
$api->set_key_required[true];06] dịch trực tiếp thành câu lệnh MySQL trên máy chủ của bạn
Yêu cầu ví dụ
$api->set_key_required[true];50
Yêu cầu trên sẽ trả về 50 người dùng mới nhất đã bao gồm Thompson ở đâu đó trong các cột first_name, last_name, email, city, state hoặc bio của họ
Thông số đáng chú ý
$api->set_key_required[true];
09 sử dụng tìm kiếm FULLTEXT của MySQL để tìm các kết quả phù hợp nhất trong cơ sở dữ liệu với giá trị của tham số$api->set_key_required[true];
04 trả về kết quả được sắp xếp theo tên cột được cung cấp làm giá trị của tham số$api->set_key_required[true];
03 chỉ định số lượng kết quả trả về. Nếu không được bao gồm dưới dạng tham số, giá trị mặc định là$api->set_key_required[true];
502 và giá trị tối đa là$api->set_key_required[true];
503$api->set_key_required[true];
504 sử dụng MySQL$api->set_key_required[true];
505 để phân trang kết quả từ cơ sở dữ liệu. Được sử dụng hiệu quả nhất khi kết hợp với$api->set_key_required[true];
03
Danh sách đầy đủ tất cả các tham số của Trình tạo API được chỉ định trong phần Tham chiếu tham số của tài liệu này
Trả về JSON
Tất cả dữ liệu do API của bạn trả về được bao bọc trong một đối tượng JSON có thuộc tính mảng
$api->set_key_required[true];15. Nếu có lỗi hoặc không tìm thấy kết quả, biến
$api->set_key_required[true];19 với thông báo lỗi tương ứng sẽ được trả về thay vì thuộc tính
$api->set_key_required[true];15. Nếu API của bạn được thiết lập không chính xác trong trang
$api->set_key_required[true];0 của bạn, một mảng
$api->set_key_required[true];14 được trả về
Bên trong thuộc tính
$api->set_key_required[true];15 là một mảng các đối tượng được trả về do Tham số trình tạo API URL được nêu ngay sau đây
$api->set_key_required[true];51
Ghi chú. Thuộc tính
$api->set_key_required[true];15 luôn là một mảng đối tượng ngay cả khi chỉ có một kết quả
Sử dụng dữ liệu
Do API xuất dữ liệu bằng JSON nên kết quả của yêu cầu API http có thể được tải vào một dự án được viết bằng hầu hết mọi ngôn ngữ. Tôi đã chọn cung cấp các ví dụ mã ngắn gọn bằng cách sử dụng
$api->set_key_required[true];514, tuy nhiên, các đoạn mã này phác thảo các khái niệm cơ bản về tải và sử dụng dữ liệu API của bạn và dễ dàng áp dụng cho ngôn ngữ khác
$api->set_key_required[true];52
Xử lý lỗi
Các yêu cầu API thường không trả về kết quả nào vì không tìm thấy kết quả nào đáp ứng tiêu chí của yêu cầu. Vì lý do này, điều quan trọng là phải biết cách xử lý API
$api->set_key_required[true];19. JSON được trả về trong trường hợp này là
$api->set_key_required[true];516 hoặc bất kỳ thứ gì bạn chỉ định bằng cách sử dụng
$api->set_key_required[true];517
Xử lý
$api->set_key_required[true];518 rất đơn giản. Tất cả những gì bạn cần làm là kiểm tra xem thuộc tính
$api->set_key_required[true];19 có tồn tại trong đối tượng JSON kết quả không. Nếu nó thực thi mã khi có lỗi. Nếu không, hãy tiếp tục với chương trình vì yêu cầu trả về ít nhất một đối tượng kết quả
$api->set_key_required[true];53
Gửi dữ liệu đến cơ sở dữ liệu của bạn
Ngoài việc sử dụng Trình tạo API để tạo API có thể truy cập web, còn có một số phương pháp cho phép bạn thực sự thêm/chỉnh sửa dữ liệu trong cơ sở dữ liệu của mình bằng cách sử dụng phương pháp
$api->set_key_required[true];2 hoặc
$api->set_key_required[true];10
Phương thức tĩnh
$api->set_key_required[true];522 xử lý cả hai nhu cầu này. Hành vi mặc định của phương pháp này có hai tham số và được sử dụng để chèn dữ liệu vào cơ sở dữ liệu bằng cách tự động tạo câu lệnh MySQL
$api->set_key_required[true];523. Mỗi lần
$api->set_key_required[true];524 được gọi, nó chỉ ảnh hưởng đến 1 hàng. Tham số đầu tiên là một mảng kết hợp có tên cột là mỗi khóa và giá trị bạn muốn chèn vào cột đó là giá trị. Tham số thứ hai là tên của bảng sẽ sử dụng khi thực hiện truy vấn. Nếu bạn đang thực hiện truy vấn trên bảng mà bạn đã chuyển vào
$api->set_key_required[true];525 hoặc
$api->set_key_required[true];19 thì bạn có thể truy cập bảng đó bằng thuộc tính tĩnh
$api->set_key_required[true];17. Nếu không, bạn có thể chỉ định tên bảng dưới dạng chuỗi
Dưới đây là ví dụ về cách chèn người dùng mới vào cơ sở dữ liệu mẫu mà chúng tôi đã sử dụng xuyên suốt tài liệu này. Nếu bạn đã quen với việc tạo_______5528 hoặc
$api->set_key_required[true];529 bằng Javascript thì việc chèn và cập nhật các hàng hiện có trong cơ sở dữ liệu của bạn thật dễ dàng. [ví dụ đến sớm]
chèn
Nếu biểu mẫu html trên trang đăng ký trông như thế này
$api->set_key_required[true];54
Sau đó, mã php trên trang gửi, thường là cùng một trang có biểu mẫu html như trong
$api->set_key_required[true];530, sẽ trông như thế này
$api->set_key_required[true];55
Đang cập nhật
Tham số thứ ba tùy chọn của
$api->set_key_required[true];524 cho phép cơ sở dữ liệu cập nhật các hàng hiện có miễn là cột id tồn tại trong bảng và id của hàng cần cập nhật được chuyển vào dưới dạng cặp khóa => giá trị trong tham số đầu tiên của phương thức. Khi cập nhật, tham số thứ 3 của phương thức phải là một chuỗi đại diện cho tên của cột để cập nhật
$api->set_key_required[true];56
Khác
Phương thức
$api->set_key_required[true];532 lấy một chuỗi hoặc mảng và khử trùng nó bằng mysql_real_escape_string và htmlspecialchars. Tôi không phải là chuyên gia bảo mật và rất có thể cần phải vệ sinh chuỗi nhiều hơn trước khi chèn dữ liệu vào cơ sở dữ liệu của bạn
Phương thức
$api->set_key_required[true];533 cho phép bạn thực thi các câu lệnh SQL thô dưới dạng các chuỗi được truyền vào dưới dạng tham số của nó. Ví dụ, nếu bạn muốn thay đổi cấu trúc của bảng từ cơ sở dữ liệu mà bạn đã kết nối, bạn có thể sử dụng phương pháp này. Hoặc nếu bạn muốn cập nhật hàng loạt người dùng, bạn cũng có thể sử dụng phương pháp này
$api->set_key_required[true];57
Hãy cẩn thận khi sử dụng
$api->set_key_required[true];533 vì bạn có thể thực hiện các thay đổi đối với Cơ sở dữ liệu có thể làm gián đoạn quá trình thiết lập API của bạn
Tham chiếu tham số API
Phần này ghi lại chi tiết tất cả các tham số URL của Trình tạo API hiện có sẵn để sử dụng khi thực hiện yêu cầu http tới API của bạn
Nó sử dụng một bảng đã tạo với thiết lập được chỉ định trước đó trong tài liệu này
Tham số khóa API
Nếu API đã được thiết lập để yêu cầu một khóa duy nhất, thì nó sẽ cần được đưa vào mỗi yêu cầu. Nếu API được thiết lập theo cách này, bạn sẽ không thể truy cập dữ liệu của API trừ khi bạn được cung cấp khóa hợp lệ. API Trình tạo API có chức năng này bị tắt theo mặc định nhưng chủ sở hữu API có thể ]bật bằng phương pháp
$api->set_key_required[true];14
phím thông số.
$api->set_key_required[true];536
Giá trị tham số. Khóa 40 ký tự duy nhất
$api->set_key_required[true];537
Thí dụ
$api->set_key_required[true];58
Ghi chú. Không bao gồm khóa API hợp lệ khi được yêu cầu hoặc thực hiện nhiều hơn số yêu cầu được phép trong một ngày sẽ ném đối tượng
$api->set_key_required[true];19 thay cho đối tượng
$api->set_key_required[true];15
Tham số khóa riêng
Tương tự như Tham số khóa API, Tham số khóa riêng giới hạn quyền truy cập vào API. Tuy nhiên, không giống như Khóa API, chỉ có một Khóa riêng được phép cho mỗi API. Tham số này được sử dụng nếu API được dự định là riêng tư [i. e. cho chỉ một người dùng, không chỉ giới hạn quyền truy cập như với Tham số khóa API]. Chức năng này bị tắt theo mặc định nhưng chủ sở hữu API có thể bật bằng
$api->set_key_required[true];540
phím thông số.
$api->set_key_required[true];541
Giá trị tham số. Khóa 40 ký tự duy nhất
$api->set_key_required[true];537
Thí dụ
$api->set_key_required[true];59
Tham số cột
Tham số cột cho phép bạn truy vấn dữ liệu cho một giá trị cột cụ thể trong đó khóa tham số được chỉ định là tên cột trong cơ sở dữ liệu của bạn. Các tham số cột có thể được xếp chồng lên nhau cho các truy vấn cụ thể hơn
Phím thông số. Tên cột [i. e.
$api->set_key_required[true];543] để thực hiện truy vấn trên
Giá trị tham số. Tra cứu mong muốn
$api->set_key_required[true];544,
$api->set_key_required[true];545 hoặc
$api->set_key_required[true];546 tương ứng với tên cột trong cơ sở dữ liệu như được chỉ định bởi khóa của tham số
Thí dụ
$api->set_key_required[true];60
Yêu cầu ví dụ này sẽ trả về tối đa 10 người dùng có họ là Thompson được sắp xếp theo thứ tự bảng chữ cái họ
ghi chú. Tham số cột bị ghi đè nếu tham số
$api->set_key_required[true];09 được bao gồm trong yêu cầu
Tham số tìm kiếm
Tham số
$api->set_key_required[true];09 sử dụng tìm kiếm MySQL
$api->set_key_required[true];549 Match[]… Against[]… để tìm các kết quả phù hợp nhất với chuỗi đã tìm kiếm
phím thông số.
$api->set_key_required[true];09
Giá trị tham số. Truy vấn mong muốn
$api->set_key_required[true];544
Thí dụ
$api->set_key_required[true];61
ghi chú. Kết quả
$api->set_key_required[true];09 được sắp xếp tự động theo mức độ liên quan hoặc nếu mức độ liên quan được tìm thấy là tùy ý, theo giá trị do chủ sở hữu API đặt bằng phương pháp
$api->set_key_required[true];553. Không thể sử dụng tham số
$api->set_key_required[true];04 khi tham số
$api->set_key_required[true];09 được chỉ định. Thông tin thêm về lý do bên dưới…
Kết hợp mặc định[]…Chống lại[]… Các câu lệnh MySQL tìm kiếm cơ sở dữ liệu bằng cách sử dụng ngưỡng tương tự 50%. Điều này có nghĩa là nếu một chuỗi tìm kiếm xuất hiện trong hơn một nửa số hàng trong cơ sở dữ liệu thì tìm kiếm sẽ bỏ qua chuỗi đó. Vì có thể các trang web sẽ có các thẻ tương tự nên tôi đã xây dựng API để tự động tìm kiếm lại
$api->set_key_required[true];556 nếu không tìm thấy kết quả nào trong lần thử đầu tiên. Nếu tìm thấy kết quả trong lần tìm kiếm thứ hai, chúng sẽ được sắp xếp theo cột mặc định do chủ sở hữu API đặt
Thứ tự theo thông số
Tham số này được sử dụng với các tham số cột để sắp xếp người dùng được trả về theo giá trị đã chỉ định. Nếu
$api->set_key_required[true];04 không được chỉ định, giá trị của nó sẽ mặc định là giá trị được đặt bởi
$api->set_key_required[true];558 của API trong trang
$api->set_key_required[true];0.
$api->set_key_required[true];04 sẽ bị bỏ qua khi tham số
$api->set_key_required[true];09 được chỉ định
phím tham số.
$api->set_key_required[true];04
Giá trị tham số. Tên cột [i. e.
$api->set_key_required[true];563] để đặt hàng theo
Thí dụ
$api->set_key_required[true];62
Yêu cầu này trả về 15 người dùng gần đây nhất từ Virginia
Thông số dòng chảy
Tham số này chỉ định các tùy chọn MySQL
$api->set_key_required[true];08 và
$api->set_key_required[true];07 tuân theo câu lệnh
$api->set_key_required[true];06. Nếu
$api->set_key_required[true];05 không được chỉ định, nó sẽ mặc định là
$api->set_key_required[true];07
phím thông số.
$api->set_key_required[true];05
Giá trị tham số.
$api->set_key_required[true];08 hoặc
$api->set_key_required[true];07
Thí dụ
$api->set_key_required[true];63
Yêu cầu này trả về 15 người dùng gần đây nhất từ Virginia. ghi chú. Các giá trị của
$api->set_key_required[true];05 không phân biệt chữ hoa chữ thường
Tham số giới hạn
Tham số
$api->set_key_required[true];03 hoạt động tương tự như MySQL
$api->set_key_required[true];574. Nó chỉ định số lượng người dùng tối đa được trả lại. Giá trị mặc định, nếu không xác định là
$api->set_key_required[true];502. Giá trị tối đa mặc định của kết quả có thể được trả lại trong một yêu cầu là
$api->set_key_required[true];503
phím thông số.
$api->set_key_required[true];03
Giá trị tham số.
$api->set_key_required[true];545 giữa
$api->set_key_required[true];579 hoặc giữa
$api->set_key_required[true];580 và giá trị tối đa do chủ sở hữu API chỉ định bằng cách sử dụng
$api->set_key_required[true];581
Thí dụ
$api->set_key_required[true];64
Trả về 5 người dùng gần đây nhất từ Illinois
Tham số trang
Tham số trang được sử dụng để phân trang kết quả. Nó theo dõi tập hợp [hoặc trang] kết quả nào được trả về. Điều này tương tự như câu lệnh OFFSET của MySQL. Nếu không được chỉ định, giá trị trang sẽ mặc định là
$api->set_key_required[true];580
phím tham số.
$api->set_key_required[true];504
Giá trị tham số.
$api->set_key_required[true];545 lớn hơn
$api->set_key_required[true];585
THÍ DỤ
$api->set_key_required[true];65
Yêu cầu này sẽ trả về "trang" thứ 3 của
$api->set_key_required[true];09 kết quả
Chẳng hạn, trong một ví dụ không chắc chắn rằng tất cả người dùng đều có chuỗi "lập trình" trong tiểu sử của họ, cài đặt
$api->set_key_required[true];587 sẽ trả về các trang web có id là
$api->set_key_required[true];588, cài đặt
$api->set_key_required[true];589 sẽ trả về
$api->set_key_required[true];590, v.v...
Ghi chú. MySQL
$api->set_key_required[true];505 được tính phía máy chủ bằng cách nhân giá trị của
$api->set_key_required[true];03 với giá trị của
$api->set_key_required[true];504 trừ đi một
thông số chính xác
Tham số chính xác được sử dụng cùng với các tham số cột và chỉ định xem các giá trị của chúng có được truy vấn với độ chính xác tương đối hay chính xác hay không. Nếu không được bao gồm trong yêu cầu URL, tham số
$api->set_key_required[true];594 mặc định là
$api->set_key_required[true];17
phím thông số.
$api->set_key_required[true];594
Giá trị tham số.
$api->set_key_required[true];18 và
$api->set_key_required[true];598
Thí dụ
$api->set_key_required[true];66
Yêu cầu này sẽ giới hạn kết quả trả về cho người dùng có id chính xác là 10. Nếu tham số
$api->set_key_required[true];594 không được chỉ định hoặc được đặt thành
$api->set_key_required[true];598, yêu cầu tương tự cũng có thể trả về người dùng có id có 10 trong đó [i. e. 1310, 10488, 100, v.v…]. Bao gồm tham số
$api->set_key_required[true];601 trong yêu cầu API http tương đương với việc sử dụng câu lệnh
$api->set_key_required[true];602
$api->set_key_required[true];603
ghi chú. Các giá trị của
$api->set_key_required[true];594 không phân biệt chữ hoa chữ thường
Loại trừ thông số
Tham số loại trừ được sử dụng cùng với tham số cột để loại trừ một hoặc nhiều hàng kết quả cụ thể khỏi truy vấn. Nó bị tắt theo mặc định nhưng có thể được chủ sở hữu API bật
phím thông số.
$api->set_key_required[true];605
Giá trị tham số. một danh sách được phân cách bằng dấu phẩy của hàng bị loại trừ của
$api->set_key_required[true];563
Thí dụ
$api->set_key_required[true];67
Ví dụ này sẽ trả về 50 người dùng không phải là số
$api->set_key_required[true];607,
$api->set_key_required[true];608 và
$api->set_key_required[true];609 sử dụng gmail được sắp xếp theo họ
Ghi chú. Nếu tham số
$api->set_key_required[true];605 được bao gồm trong một yêu cầu http tới API đã tắt chức năng này, thì một
$api->set_key_required[true];19 đúng cách sẽ xuất hiện để thông báo cho người dùng
Thông số chỉ đếm
Tham số
$api->set_key_required[true];612 khác với tất cả các tham số Trình tạo API khác vì nó không trả về một mảng các đối tượng kết quả. Thay vào đó, nó trả về một đối tượng duy nhất là phần tử đầu tiên trong mảng
$api->set_key_required[true];15. Đối tượng này chỉ có một thuộc tính,
$api->set_key_required[true];614, trong đó giá trị
$api->set_key_required[true];544 tương ứng mô tả số lượng kết quả được trả về bởi phần còn lại của tham số url. Nếu tham số
$api->set_key_required[true];616 không được chỉ định, giá trị mặc định là
$api->set_key_required[true];598. Khi
$api->set_key_required[true];616 được đặt thành
$api->set_key_required[true];18, yêu cầu sẽ chỉ đánh giá và trả về số lượng kết quả mà phần còn lại của các tham số url tìm thấy và yêu cầu sẽ không trả về bất kỳ dữ liệu hàng nào
phím thông số.
$api->set_key_required[true];616
Giá trị tham số.
$api->set_key_required[true];18 hoặc
$api->set_key_required[true];598
THÍ DỤ
$api->set_key_required[true];68
Yêu cầu này trả về số lượng người dùng có tên "Thomas". Giá trị đếm được trả về dưới dạng
$api->set_key_required[true];544
Ghi chú. Giá trị của
$api->set_key_required[true];616 không phân biệt chữ hoa chữ thường
Thông số in đẹp
Tham số
$api->set_key_required[true];625 trả về phản hồi có thụt đầu dòng và ngắt dòng. Nếu
$api->set_key_required[true];625 được đặt thành
$api->set_key_required[true];18, kết quả do máy chủ trả về sẽ có thể đọc được bằng con người [được in đẹp]. Với hầu hết các thiết lập API, Pretty Print sẽ được bật theo mặc định nhưng chủ sở hữu API có thể đã tắt tính năng này. Dù bằng cách nào, Pretty Print có thể được bật hoặc tắt với tham số này
phím thông số.
$api->set_key_required[true];625
Giá trị tham số.
$api->set_key_required[true];18 hoặc
$api->set_key_required[true];598
Thí dụ
$api->set_key_required[true];69
Ghi chú. Giá trị của
$api->set_key_required[true];625 không phân biệt chữ hoa chữ thường. Nếu một lượng lớn dữ liệu đang được truyền và khả năng đọc của con người không quan trọng, bạn nên tắt tính năng in đẹp để kích hoạt các yêu cầu API và phân tích dữ liệu nhanh hơn
Giấy phép và tín dụng
Thư viện API Builder PHP Mini được phát triển và duy trì bởi Brannon Dorsey và được xuất bản theo Giấy phép MIT. Nếu bạn nhận thấy bất kỳ lỗi nào, có bất kỳ câu hỏi nào hoặc muốn giúp tôi phát triển, vui lòng gửi vấn đề hoặc yêu cầu kéo, viết về vấn đề đó trên wiki hoặc liên hệ với tôi