Xem 15,246
Cập nhật nội dung chi tiết về Tôi Đã Viết Api Document Cho Dự Án Như Thế Nào? mới nhất ngày 17/05/2022 trên website Hanoisoundstuff.com. Hy vọng thông tin trong bài viết sẽ đáp ứng được nhu cầu ngoài mong đợi của bạn, chúng tôi sẽ làm việc thường xuyên để cập nhật nội dung mới nhằm giúp bạn nhận được thông tin nhanh chóng và chính xác nhất. Cho đến nay, bài viết này đã thu hút được 15,246 lượt xem.
--- Bài mới hơn ---
Xin chào các bạn, hiện tại sau khi dự án của mình hoàn thành được phase 1 thì công việc cần thiết bây giờ là phải viết lại 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.
Đầu tiên mình nghĩ nó cũng chỉ đơn giản thôi, nhưng mà không. Lúc bắt tay vào làm thì mới thấy nó có nhiều cái phức tạp, và cái hay ho nhất mà mình thu về được đó là việc viết API document. Sau một hồi mình viết document bằng “cơm” thì được anh em khai sáng cho một số Tools hỗ trợ việc viết API document.
Và trong bài viết này, mình xin phép được chia sẻ một công cụ khá hay cũng như sơ qua cách sử dụng Laravel Api Doc Generator. Hi vọng rằng bài viết này có thể hỗ trợ cho những bạn “lần đầu làm chuyện ấy” giống như mình.
-
Và sau một hồi tìm kiếm ở tận phương trời xa lắm, thì mình phát hiện ra là Laravel cũng có một công cụ hỗ trợ việc viết API Document.
-
Sơ qua 1 chút thông tin trên github của laravel-apidoc-generator:
Như các bạn có thể thấy thì commit mới nhất trên repo này là vào 15/6, tức là nó vẫn đang được phát triển liên tục.
Còn về số sao mà cộng đồng đánh giá thì rơi vào khoảng 2000 sao, không phải quá cao nhưng cũng là 1 mức đáng ngưỡng mộ đối với một repo opensource mới.
-
Yêu cầu cài đặt: tối thiểu PHP 7 và Laravel 5.5.
-
Cài đặt:
Cài đặt bằng composer:
composer required mpociot/laravel-apidoc-generatorKhai báo trong service provider trong file
bootstrap/app.php:Tạo file config: sau khi chạy câu lệnh này, trong thư mục
configcủa project sẽ xuất hiện fileapidoc.phpphp artisan vendor:publish --provider= "MpociotApiDocApiDocGeneratorServiceProvider" --tag=apidoc-config -
Thử vọc vạch 1 số thứ trong config xem sao?
-
Cách thức thực hiện:
Cài đặt các thứ đã xong xuôi hết rồi, giờ thì chạy xem thành quả của mình nào.
php artisan apidoc:generateSau khi quá trình này được hoàn tất, tài liệu HTML sẽ được ghi vào file:
publicdocsindex.html- B2: Bật server và kiểm tra kết quả thu được
Tiếp theo, hãy bật server lên với câu lệnh
php artisan serveỞ cột ngoài cùng bên trái là list những api được sử dụng trong project mà đã được lấy ra (trừ một số cái bị skip ở bước 1).
Phần còn lại là thông tin chi tiết của API đấy:
- Phương thức: GET/POST/PATCH/PUT/DELETE
- Route:
- Example request & example response:
Có người từng nói “Miếng phô mai có sẵn chỉ có ở trên bẫy chuột”. Vì vậy chúng ta không thể dùng ngay như bên trên được (chỉ là demo một chút cho các bạn thôi) mà phải cất công cấu hình một chút cho phù hợp với project và nhu cầu của bản thân!
Giờ thì cùng xem file config/apidoc.php có những thông số gì nào?
All Rights Reserved
--- Bài cũ hơn ---
Bạn đang đọc nội dung bài viết Tôi Đã Viết Api Document Cho Dự Án Như Thế Nào? trên website Hanoisoundstuff.com. Hy vọng một phần nào đó những thông tin mà chúng tôi đã cung cấp là rất hữu ích với bạn. Nếu nội dung bài viết hay, ý nghĩa bạn hãy chia sẻ với bạn bè của mình và luôn theo dõi, ủng hộ chúng tôi để cập nhật những thông tin mới nhất. Chúc bạn một ngày tốt lành!