Thời lượng tổng: 1 tuần
Level: Beginner
Yêu cầu: Hoàn thành Modules 1-7
Tổng quan Module
Một API tốt mà không có tài liệu (Documentation) thì cũng giống như một kho báu bị khóa kín mà không có bản đồ. Trong Backend Design System, tài liệu là "giao diện" chính để bạn giao tiếp với Frontend Developers và các đối tác. Module này hướng dẫn bạn cách xây dựng tài liệu API sống động, luôn cập nhật và tuân thủ các tiêu chuẩn quốc tế.
Danh sách bài học
| Bài | Tiêu đề | Thời lượng | Mô tả |
|---|---|---|---|
| 8.1 | OpenAPI & Swagger | 20 phút | Sử dụng chuẩn OpenAPI để mô tả API |
| 8.2 | Interactive Docs | 20 phút | Xây dựng Sandbox/Playground giúp thử nghiệm API trực tiếp |
| 8.3 | Postman & SDK Generation | 20 phút | Tự động hóa việc tạo Postman Collection và bộ Library (SDK) |
Kết quả học tập
Sau module này, bạn sẽ:
- ✅ Viết được file đặc tả API sử dụng chuẩn OpenAPI 3.x.
- ✅ Tích hợp được Swagger UI / Redoc vào hệ thống Backend.
- ✅ Biết cách tự động hóa quy trình cập nhật tài liệu mỗi khi code thay đổi.