Hướng dẫn dùng laravel docs trong PHP
Đã đăng vào thg 2 13, 2020 7:05 SA 3 phút đọc Xin chào mọi người. Hiện tại mình đang phát triển 1 dự án kết hợp Laravel API và reactjs và việc để dễ dàng phối hợp giữa 2 team frontend và backend và cần tài liệu dự án để sau này dễ dàng bảo trì, phát triển hoặc bàn giao dự án cho đội phát triển tiếp theo nên dự án có yêu cầu viết document cho API, sau 1 thơi gian tìm hiểu và áp dụng thì mình xin phép chia sẻ một số kiến thức với mọi người. Về viết document cho laravel API thì mình sử dụng packet Laravel API Documentation Generator 1 . Giới thiêu package và cài đặtLaravel API Documentation Generator là package generate API Document hỗ trợ cho laravel. Packege này hiện có gần 2500star và hơn 400 lượt fork và vẫn đang được phát triên. Package này yêu cầu Laravel >= 5.7 và PHP >= 7.2 Để cài đặt vào dự án Laravel, chạy lệnh composer: Cài đặtChạy lệnh để cài đặt thư
viện Cấu hìnhFile config của package sẽ nằm ở /config/apidoc.php. Giải thích về config này như sau :
Viết Document APIĐể viết API document, bạn vào method trong controller mà route cần viết document trỏ tới. Và viết bên trên method đó như phần dưới mình viết document cho method index của trang list user:
Dòng đầu tiên là tên của API . Ở đây là api/users Kết quảSau khi cấu hình và viết API thì chúng ta chạy lệnh: All rights reserved |