Xu Hướng 7/2022 # Tôi Đã Viết Api Document Cho Dự Án Như Thế Nào? # Top View

Xem 8,613

Bạn đang xem bài viết Tôi Đã Viết Api Document Cho Dự Án Như Thế Nào? được cập nhật mới nhất ngày 01/07/2022 trên website Ezlearning.edu.vn. Hy vọng những thông tin mà chúng tôi đã chia sẻ là hữu ích với bạn. Nếu nội dung 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. Cho đến thời điểm hiện tại, bài viết này đã đạt được 8,613 lượt xem.

--- Bài mới hơn ---

  • Viết Api Document Cho Dự Án Sử Dụng Laravel
  • Tạo Ứng Dụng Android Đơn Giản Đưa Lên Google Play Trong 10 Tiếng
  • Cách Tạo Ứng Dụng Android / Ios Không Cần Biết Lập Trình
  • Appendix: Cách Tiếp Cận Trung Tâm
  • Appendix: Cách Tiếp Cận Kiểm Soát Dịch Vụ
  • 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-generator

      Khai 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 config của project sẽ xuất hiện file apidoc.php

      php 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:generate

      Sau 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 ---

  • Cách Viết Rails Api Document
  • Giới Thiệu Tool Swagger Ui
  • Học Kiểm Thử Api Trong 10 Phút
  • Cách Tạo Api Với Rails (Phần 2) Viết Test Case
  • How To Write Test Cases ( Hướng Dẫn Cách Viết Testcases)
  • Cập nhật thông tin chi tiết về Tôi Đã Viết Api Document Cho Dự Án Như Thế Nào? trên website Ezlearning.edu.vn. Hy vọng nội dung bài viết sẽ đáp ứng được nhu cầu của bạn, chúng tôi sẽ thường xuyên cập nhật mới nội dung để bạn nhận được thông tin nhanh chóng và chính xác nhất. Chúc bạn một ngày tốt lành!

  • Web hay
  • Links hay
  • Push
  • Chủ đề top 10
  • Chủ đề top 20
  • Chủ đề top 30
  • Chủ đề top 40
  • Chủ đề top 50
  • Chủ đề top 60
  • Chủ đề top 70
  • Chủ đề top 80
  • Chủ đề top 90
  • Chủ đề top 100
  • Bài viết top 10
  • Bài viết top 20
  • Bài viết top 30
  • Bài viết top 40
  • Bài viết top 50
  • Bài viết top 60
  • Bài viết top 70
  • Bài viết top 80
  • Bài viết top 90
  • Bài viết top 100
  • CẦM ĐỒ TẠI F88
    15 PHÚT DUYỆT
    NHẬN TIỀN NGAY

    VAY TIỀN NHANH
    LÊN ĐẾN 10 TRIỆU
    CHỈ CẦN CMND

    ×