Xu Hướng 5/2022 # Viết Api Document Cho Dự Án Sử Dụng Laravel # Top View

Xem 2,079

Bạn đang xem bài viết Viết Api Document Cho Dự Án Sử Dụng Laravel được cập nhật mới nhất ngày 18/05/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 2,079 lượt xem.

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

  • 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ụ
  • Appraisal Là Gì? Mục Tiêu Và Vai Trò Cụ Thể Như Thế Nào ?
  • 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

    Cài đặt

    Chạy lệnh để cài đặt thư viện

    composer require --dev mpociot/laravel-apidoc-generator

    Xuất bản tệp cấu hình bằng cách chạy lệnh:

    php artisan vendor:publish --provider="MpociotApiDocApiDocGeneratorServiceProvider" --tag=apidoc-config

    File config của package sẽ nằm ở Hanoisoundstuff.com lệnh sau để tạo API docs

    php artisan apidoc:generate

    Như vậy là chúng ta vừa tạo API docs mặc định để có thể tùy biến và viết thêm chi tiết cho API docs chúng ta sẽ chỉnh sửa như sau

    Cấu hình

    File config của package sẽ nằm ở chúng tôi Giải thích về config này như sau :

    type: Kiểu document, nếu chọn là static thì document sẽ là một file HTML nằm ở public/docs, nếu chọn laravel thì document sẽ là một file blade nằm trong resources/views/apidoc.

    route: để cố định là laravel

    base_url: base URL của API, mặc định là config(‘app.url’)

    postman: cài đặt post man collection

    enabled: mặc định là true. sẽ tạo ra postman collection

    name: trên của collection

    description: mô tả cho collection

    strategies: các service để parse API docs

    logo: logo của trang API docs, kích thước chuẩn là 230 x 52

    default_group: group mặc định của các endpoint không có thuộc tính @group

    example_languages: ngôn ngữ lập trình cho các ví dụ

    fractal: tìm hiểu thêm tại: https://fractal.thephpleague.com

    routes: gồm nhiều nhóm để cài đặt cho API documents

    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

    Các dòng tiếp theo là mô tả param, response,message…

    Kết quả

    All Rights Reserved

    --- Bài cũ hơn ---

  • Tôi Đã Viết Api Document Cho Dự Án Như Thế Nào?
  • 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
  • Cập nhật thông tin chi tiết về Viết Api Document Cho Dự Án Sử Dụng Laravel 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