Quy chuẩn trong việc trao đổi, sử dụng API giữa back-end và front-end devs - Githubissues

easywebhub / tasks

List of tasks for EasyWeb members

1 stars 4 forks source link

Quy chuẩn trong việc trao đổi, sử dụng API giữa back-end và front-end devs #48

Open baotnq opened 7 years ago

baotnq commented 7 years ago

Xây dựng quy chuẩn tương tác giữa các bên back-end và front-end devs

Yêu cầu

Tổng hợp các bước cơ bản cho SwaggerUI cũng như Postman
Cách xây dựng test-cases bằng Postman để test API
Tài liệu cơ bản cho các nội dung trên (cơ bản ban đầu, điều chỉnh sau)

Đánh giá SwaggerUI

Ưu điểm:

tự động sinh ra docs và cập nhật với thay đổi trong khi lập trình
dễ dàng cho front-end hiểu được ngữ nghĩa, mô tả của các API
Nhược điểm
không thể hiện được các trường hợp (test-cases) của API với các input khác nhau Ví dụ: OK: 200, Các trường hợp khác: error message
Với các API chưa chuẩn restful, gặp khó khăn khi thể hiện

Sử dụng Postman (hoặc công cụ tương đương) để

Xây dựng test-cases, fake json data với các tình huống khác nhau
- Đặt tên theo format: [apiName]-[GET/POST/...]-[ResponseCode:200/404/301/...]
Là cơ sở tham khảo dễ dàng cho front-end devs
Chia sẻ test-cases dễ dàng (giữa các account Postman hoặc dùng chung)