Cloud Drive30s: Hướng dẫn kết nối API cơ bản

Sử dụng curl

Tất cả các yêu cầu WebDAV có thể được kiểm tra dễ dàng curl bằng cách chỉ định phương thức yêu cầu ( GET, PROPFIND, PUT…) và cung cấp nội dung yêu cầu khi cần.

Ví dụ: bạn có thể thực hiện PROPFIND yêu cầu tìm tệp trong thư mục bằng cách sử dụng:

curl 'https://cloud.example.com/remote.php/dav/files/username/folder' \
  --user username:password \
  --request PROPFIND \
  --data '<?xml version="1.0" encoding="UTF-8"?>
    <d:propfind xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns" xmlns:nc="http://nextcloud.org/ns">
      <d:prop>
        <d:getlastmodified/>
        <d:getcontentlength/>
        <d:getcontenttype/>
        <oc:permissions/>
        <d:resourcetype/>
        <d:getetag/>
      </d:prop>
    </d:propfind>'

Tạo yêu cầu kiểm tra với JavaScript

Đây là mẫu mã JavaScript để giúp bạn bắt đầu:

import { createClient } from 'webdav'
import { generateRemoteUrl } from '@nextcloud/router'
import { getCurrentUser } from '@nextcloud/auth'

const client = createClient(generateRemoteUrl('dav'))
const response = await client.getDirectoryContents(`/files/${getCurrentUser()?.uid}/folder`, {
        details: true,
        data: `<?xml version="1.0" encoding="UTF-8"?>
                <d:propfind xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns" xmlns:nc="http://nextcloud.org/ns">
                        <d:prop>
                                <d:getlastmodified/>
                                <d:getcontentlength/>
                                <d:getcontenttype/>
                                <oc:permissions/>
                                <d:resourcetype/>
                                <d:getetag/>
                        </d:prop>
                </d:propfind>`,
})

Lưu ý về không gian tên URI

Khi xây dựng nội dung yêu cầu DAV, bạn sẽ yêu cầu các thuộc tính có sẵn trong URI không gian tên cụ thể. Thông thường người ta khai báo tiền tố cho các vùng tên đó trong d:propfind phần tử của phần thân.

Đây là danh sách các không gian tên có sẵn:

Và đây là giao diện của nó trong yêu cầu DAV của bạn:

<?xml version="1.0"?>
        <d:propfind
                xmlns:d="DAV:"
                xmlns:oc="http://owncloud.org/ns"
                xmlns:nc="http://nextcloud.org/ns"
                xmlns:ocs="http://open-collaboration-services.org/ns">
                xmlns:ocm="http://open-cloud-mesh.org/ns">
        ...

Thuộc tính được hỗ trợ

Lấy thuộc tính của thư mục 

Bạn có thể yêu cầu các thuộc tính của thư mục mà không cần lấy nội dung thư mục bằng cách thêm tiêu đề vào yêu cầu.Depth: 0

Tạo thư mục ( rfc4918 )

Một thư mục có thể được tạo bằng cách gửi MKCOL yêu cầu đến thư mục đó.

MKCOL remote.php/dav/files/user/path/to/new/folder

Xóa tập tin và thư mục ( rfc4918 )

Một tập tin hoặc thư mục có thể bị xóa bằng cách gửi DELETE yêu cầu tới tập tin hoặc thư mục đó.

DELETE remote.php/dav/files/user/path/to/file

Khi xóa một thư mục, nội dung của nó sẽ bị xóa đệ quy.

Di chuyển tập tin và thư mục ( rfc4918 )

Có thể di chuyển tệp hoặc thư mục bằng cách gửi MOVE yêu cầu tới tệp hoặc thư mục và chỉ định đích trong Destination tiêu đề là url đầy đủ.

MOVE remote.php/dav/files/user/path/to/file
Destination: https://cloud.example/remote.php/dav/files/user/new/location

Hành vi ghi đè của thao tác di chuyển có thể được kiểm soát bằng cách đặt phần Overwrite đầu thành T hoặc F để bật hoặc tắt ghi đè tương ứng.

Sao chép tập tin và thư mục ( rfc4918 )

Có thể sao chép tệp hoặc thư mục bằng cách gửi COPY yêu cầu tới tệp hoặc thư mục đó và chỉ định đích trong Destination tiêu đề là url đầy đủ.

COPY remote.php/dav/files/user/path/to/file
Destination: https://cloud.example/remote.php/dav/files/user/new/location

Hành vi ghi đè của bản sao có thể được kiểm soát bằng cách đặt phần Overwrite đầu thành T hoặc F để bật hoặc tắt ghi đè tương ứng.

Cài đặt yêu thích

Một tệp hoặc thư mục có thể được đánh dấu là yêu thích bằng cách gửi PROPPATCH yêu cầu đến tệp hoặc thư mục đó và đặt oc-favorite thuộc tính

PROPPATCH remote.php/dav/files/user/path/to/file
<?xml version="1.0"?>
<d:propertyupdate xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns">
  <d:set>
        <d:prop>
          <oc:favorite>1</oc:favorite>
        </d:prop>
  </d:set>
</d:propertyupdate>

Đặt oc:favorite thuộc tính để 1 đánh dấu một tệp là yêu thích, đặt thuộc tính đó để 0 bỏ đánh dấu tệp đó là yêu thích.

Danh sách yêu thích

Có thể truy xuất mục yêu thích của người dùng bằng cách gửi REPORT yêu cầu và chỉ định oc:favorite làm bộ lọc

REPORT remote.php/dav/files/user/path/to/folder
<?xml version="1.0"?>
<oc:filter-files  xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns" xmlns:nc="http://nextcloud.org/ns">
         <oc:filter-rules>
                 <oc:favorite>1</oc:favorite>
         </oc:filter-rules>
 </oc:filter-files>

Các thuộc tính tệp có thể được yêu cầu bằng cách thêm một <d:prop/> phần tử vào yêu cầu liệt kê các thuộc tính được yêu cầu theo cách tương tự như cách thực hiện cho một PROPFIND yêu cầu.

Khi liệt kê các mục yêu thích, yêu cầu sẽ tìm đệ quy tất cả các mục yêu thích trong thư mục, tất cả các mục yêu thích của người dùng có thể được tìm thấy bằng cách gửi yêu cầu tớiremote.php/dav/files/user