Xây dựng phụ trợ tốn thời gian và tương đối khó khăn hơn đối với các nhà phát triển giao diện người dùng. Ngay cả khi bạn sử dụng công cụ tự động hóa phụ trợ, bạn vẫn cần viết một vài tập lệnh, tạo điểm cuối, mô hình, v.v.

Để giúp các nhà phát triển làm điều tương tự, chúng tôi đã ra mắt ChiselNow , con đường ngắn nhất dẫn đến một chương trình phụ trợ đầy đủ chức năng trong vài phút.

Chỉ cần xây dựng giao diện người dùng, xác định mô hình của bạn trong TypeScript và nhận API REST đầy đủ sẵn sàng hoạt động sau vài cú nhấp chuột. Không cần đăng ký hoặc thẻ tín dụng, không mất gì để bắt đầu.

Hãy tiếp tục và tìm hiểu cách xây dựng API CRUD đầy đủ chức năng với ChiselNow.

Xây dựng API CRUD

Truy cập ChiselNow và cuộn xuống một chút. Có một vài ví dụ mẫu để đề xuất các loại trường hợp sử dụng khác nhau mà ChiselNow hỗ trợ. Bạn cũng có thể viết lớp TypeScript của riêng mình để khám phá công cụ.

Hãy lấy ví dụ về mẫu được cung cấp: Trình rút ngắn URL.
Nhấp vào tùy chọn Trình rút ngắn URL và bạn sẽ có thể xem mẫu trong trình chỉnh sửa mã.

• Mẫu có tên lớp mặc định và một vài thuộc tính. Đối với hướng dẫn này, chúng ta sẽ sử dụng chúng như hiện tại.
• Chấp nhận các điều khoản và điều kiện bằng cách chọn hộp ở góc bên trái của trình chỉnh sửa.
• Bây giờ, ở bước cuối cùng, hãy nhấp vào “Tạo API của bạn ngay bây giờ”. Sẽ mất khoảng 30 giây để tạo API và thế là xong.

Sao chép Điểm cuối và Khóa API trong hệ thống của bạn vì không thể khôi phục chúng sau khi bạn điều hướng khỏi trang.

Thực hành API

Mô tả ngắn gọn về các thuật ngữ được sử dụng khi làm việc với API.

• Điểm cuối: URL này sẽ được sử dụng để tạo các yêu cầu HTTP đối với API đã tạo và bạn sẽ mở rộng trên đó bằng các tham số chuỗi truy vấn.
• Khóa API: Khóa API được sử dụng để ủy quyền và cần được cung cấp trong mọi yêu cầu trong X-Token tiêu đề HTTP.
• Lệnh CURL: Đây là tập hợp các lệnh mẫu mà bạn có thể sử dụng để đọc và ghi dữ liệu thực thể.

Phương thức POST : Nó được sử dụng để thêm các thực thể vào Cơ sở dữ liệu.

curl -X POST \
-d ‘{“originalUrl”:”Fake String”,”shortenedUrl”:”Fake String”,”expiresAt”:”2022–11–18T12:49:22.216Z”}’ \
-H ‘X-Token: YOUR-UNIQUE-API-KEY’ \
‘https://YOUR-UNIQUE-PROJECT-NAME-chiselnow.chiselstrike.io/main/url-shorteners'

{
  “id”:”a54942da-6d05–48d9-b4e5-bd628306f652",
  ”originalUrl”:”Fake String”,
  ”shortenedUrl”:”Fake String”,
  ”expiresAt”:”2022–11–18T12:49:22.216Z”
}

curl : Nó được sử dụng để truy vấn mọi thực thể.

curl ‘https://YOUR-UNIQUE-PROJECT-NAME-chiselnow.chiselstrike.io/main/url-shorteners

{
   "next_page":"/main/url-shorteners?cursor=eyJheGVzIjpbeyJrZXkiOnsiZmllbGROYW1lIjoiaWQiLCJhc2NlbmRpbmciOnRydWV9LCJ2YWx1ZSI6ImZjM2VkYzU2LTE5MjYtNGE5ZC1hYmY2LTQwYTU3NmQ3MDhiNiJ9XSwiZm9yd2FyZCI6dHJ1ZSwiaW5jbHVzaXZlIjpmYWxzZX0%3D",
   "prev_page":"/main/url-shorteners?cursor=eyJheGVzIjpbeyJrZXkiOnsiZmllbGROYW1lIjoiaWQiLCJhc2NlbmRpbmciOnRydWV9LCJ2YWx1ZSI6IjkwZWZkNmRkLTM2ZGQtNDkwMS04MmRjLTlkYTQzZTNjODc3MyJ9XSwiZm9yd2FyZCI6ZmFsc2UsImluY2x1c2l2ZSI6ZmFsc2V9",
   "results":[
      {
         "originalUrl":"Fake String 2",
         "shortenedUrl":"Fake String 2",
         "id":"UNIQUE_ID",
         "expiresAt":EXPIRE_TIME
      },
      {
         "shortenedUrl":"Fake String 1",
         "id":"UNIQUE_ID",
         "originalUrl":"Fake String 1",
         "expiresAt":EXPIRE_TIME
      },
      {
         "id":"UNIQUE_ID",
         "expiresAt":EXPIRE_TIME,
         "shortenedUrl":"Fake String 0",
         "originalUrl":"Fake String 0"
      }
   ]
}

Phương thức DELETE : Nó được sử dụng để xóa tất cả các thực thể khỏi dự án. Hãy nhớ rằng, điều này không thể được hoàn tác.

curl -X DELETE \
-H ‘X-Token: YOUR-UNIQUE-API-KEY’ \ 
‘https://YOUR-UNIQUE-PROJECT-NAME-chiselnow.chiselstrike.io/main/url-shorteners?all=true'

“Deleted entities matching ?all=true”

Đầu ra:

{“results”:[]}

Dự án có một số giới hạn: ngoài giới hạn lưu trữ và băng thông, nó sẽ tự động bị xóa sau hai ngày. Để tiếp tục sử dụng API của bạn, giữ lại dữ liệu bạn đã tạo, bạn có thể nhập dự án vào nền tảng ChiselStrike.

Các cách nhập dự án

Có hai cách để nhập dự án:

Từ màn hình ChiselNow
Để nhập ứng dụng, nhấp vào nút “Nhập” ở bên phải.

Đăng nhập bằng tài khoản GitHub của bạn.

ChiselStrike sẽ yêu cầu bạn cho phép đọc và ghi các kho lưu trữ. Nhấp vào “Ủy quyền cho ChiselStrike” để cấp quyền.

Bây giờ, hãy nhấp vào “Tạo kho lưu trữ Git trống”, thao tác này sẽ đưa bạn đến bước tạo một kho lưu trữ mới trên GitHub. Sau khi kho lưu trữ được tạo.

Điền vào các trường bằng tên người dùng Github, tên kho lưu trữ và tên dự án tương ứng.

Nhấp vào “Tiếp tục” và thực hiện!

Bây giờ, bạn có liên kết dự án trực tiếp, các tuyến đường và tất cả các thông tin khác về dự án trên ChiselStrike.

Từ nền tảng ChiselStrike

Nếu bạn đã có tài khoản ChiselStrike, hãy truy cập Bảng điều khiển ChiselStrike. Nhấp vào “Dự án mới”.

Bây giờ, hãy nhấp vào “Import ChiselNow Project”.

Tương tự như phương pháp trước, bạn sẽ phải tạo một kho lưu trữ GitHub mới và cung cấp quyền truy cập vào ChiselStrike.

Điền vào các trường tên người dùng Github, tên kho lưu trữ, tên dự án, URL điểm cuối và Khóa API mà bạn được cung cấp khi tạo dự án lần đầu. Bạn sẽ cần nó ở đây.

Nhấp vào “Tiếp tục” và thực hiện!

Dự án cũng đã được đẩy lên kho lưu trữ GitHub của bạn. Mọi thứ được tự động nhập vào kho GitHub bao gồm Tuyến đường, mô hình và chính sách. Bạn cũng có thể tìm hiểu thêm về những gì khác có thể được thực hiện với ChiselStrike bằng cách xem tài liệu .

Xin chúc mừng, bây giờ bạn đã có một dự án đầy đủ chức năng với ChiselNow. Bạn có thể truy cập GitHub của mình, thêm nhiều tính năng hơn, viết mã Phụ trợ, sửa đổi Mô hình, v.v. Bạn có thể thấy mã đã được đẩy vào kho lưu trữ GitHub của mình.

Trong các mô hình, bạn có thể thấy có ba thuộc tính: URL gốc, URL rút gọn và ngày hết hạn. Bạn có thể thay đổi tên của các thuộc tính hoặc loại của chúng và viết lại các mô hình theo dự án. Đi qua các tài liệu để tìm hiểu thêm về nó.

Các tuyến đường là nơi bạn xác định điểm cuối của mình. Bạn có thể xem qua tài liệu để tìm hiểu thêm về nó.

Để xây dựng một chương trình phụ trợ phức tạp hơn và đưa nguyên mẫu của bạn vào sản xuất, hãy xem trang tài liệu của chúng tôi .

Hãy cho chúng tôi biết nếu bạn tạo ra thứ gì đó thú vị bằng cách sử dụng ChiselStrike hoặc ChiselNow trên Discord hoặc Twitter của chúng tôi .