RESTful APIs
RESTful APIs
REST là một bộ quy ước để hai máy nói chuyện qua HTTP mà không phải bàn lại từ đầu mỗi lần. Ba chặng, đi từ đọc hiểu một request tới thiết kế được một API người khác dùng được.
9 cột mốc · 2 có bài trong app
Bắt đầu
1Đọc hiểu một request
Nhìn vào một request bất kỳ và biết nó đang xin gì, được trả lời ra sao.
- Method và pathcó bàiGET đọc, POST tạo, PUT/PATCH sửa, DELETE xoá. Đường dẫn chỉ ra thứ đang nói tới.
- Mã trạng tháicó bài2xx xong, 4xx bên gọi sai, 5xx bên nhận hỏng. Ba nhóm đó trả lời câu lỗi tại ai.
- Header và bodytự tìm hiểuHeader là thông tin về gói tin, body là nội dung. Content-Type quyết định bên kia đọc body thế nào.
2Gọi cho đúng
Gọi API của người khác mà không tự tạo ra lỗi cho mình.
- Xác thựctự tìm hiểuToken trong header Authorization. Đừng bao giờ nhét khoá vào URL — URL bị ghi vào log.
- Phân trangtự tìm hiểuKhông API nào trả về mười triệu bản ghi một lần. Đọc kỹ cách nó cắt trang.
- Xử lý lỗi và thử lạitự tìm hiểu429 là bị chặn vì gọi quá nhanh; 5xx thì thử lại có ích, 4xx thì không.
3Tự thiết kế một API
Ra được một API mà người khác đoán được cách dùng trước khi đọc tài liệu.
- Đặt tên tài nguyêntự tìm hiểuDanh từ số nhiều, phân cấp rõ: /users/7/orders. Đường dẫn nên đoán được.
- Idempotenttự tìm hiểuGọi hai lần cho ra cùng kết quả. Quan trọng vì mạng lỗi thì bên kia sẽ gọi lại.
- Versioningtự tìm hiểuĐổi API đang có người dùng mà không làm hỏng ứng dụng của họ.
Đích
Lộ trình dừng ở đây
Ba chặng trên đủ để dùng và viết API hằng ngày. Phần dưới là những hướng khác của cùng bài toán.
- GraphQLKhi bên gọi muốn tự chọn hình dạng dữ liệu — có bài riêng trong app.
- OpenAPIMô tả API bằng một file máy đọc được, sinh ra tài liệu và code client.
- CORSVì sao trình duyệt chặn request của bạn còn curl thì không.
- WebhookChiều ngược lại: máy chủ gọi vào ứng dụng của bạn khi có chuyện xảy ra.