Install Swagger Laravel Lumen
swagger
2
Laravel
37
Lumen
4
White

Dần Huỳnh viết ngày 09/08/2019

Chào các bạn, hôm nay mình sẽ giới thiệu tool khá nổi tiếng dùng để tạo ra API document: Swagger UI.
Swagger UI là một tool cho phép bất cứ ai cũng có thể hình dung và tương tác với tài nguyên API của hệ thống. Swagger sẽ tự động generates ra API document từ file config swagger, với cái nhìn trực quan và việc triển khai trở nên dễ dàng về phía client.

Cài đặt

Bước 1: chúng ta sẽ tạo mới một project lument
composer create-project --prefer-dist laravel/lumen blog
Bước 2: cài đặt giao diện darkaonline-swagger cho project
composer require "darkaonline/swagger-lume:5.6."
Bước 3: config swagger cho project
app->withFacades();
app->configure('swagger-lume');
$app->register(\SwaggerLume\ServiceProvider::class);

sau đó chúng ta sẽ chạy lệnh cmd: php artisan swagger-lume:publish-config && php artisan swagger-lume:publish
Bước 4: cài đặt zircote-swagger cho project
composer require zircote/swagger-php
Bước 5: mở file controller.php copy đoạn code này vào:
` /
*

  • @OA\OpenApi(
  • @OA\Server(
  • url="http://localhost:8080",
  • description="API server",
  • ),
  • @OA\Info(
  • version="1.0.0",
  • title="Swagger Lumen",
  • description="API Swagger Lumen thể hiện tính năng của Swagger 3 - Lumen 5.6",
  • termsOfService="http://swagger.io/terms/",
  • @OA\Contact(name="Swagger API Team"),
  • @OA\License(name="Huỳnh Mạnh Dần")
  • ),
  • ) */

/**

  • @OA\SecurityScheme(
  • type="oauth2",
  • name="petstore_auth",
  • securityScheme="petstore_auth",
  • @OA\Flow(
  • flow="implicit",
  • authorizationUrl="http://petstore.swagger.io/oauth/dialog",
  • scopes={
  • "write:pets": "modify pets in your account",
  • "read:pets": "read your pets",
  • }
  • )
  • )
  • @OA\SecurityScheme(
  • type="apiKey",
  • in="header",
  • securityScheme="api_key",
  • name="api_key"
  • ) */ `

Bước 6: sau khi hoàn tất các công việc trên, chạy lệnh các lệnh sau
php artisan swagger-lume:publish
php artisan swagger-lume:generate
php -S localhost:8080 public/index.php

Các bạn mở trình duyện lên copy đường link: http://localhost:8000/api/documentation
Chúc các bạn thành công!

Bình luận


White
{{ comment.user.name }}
Bỏ hay Hay
{{comment.like_count}}
Male avatar
{{ comment_error }}
Hủy
   

Hiển thị thử

Chỉnh sửa

White

Dần Huỳnh

3 bài viết.
2 người follow
Kipalog
{{userFollowed ? 'Following' : 'Follow'}}
Cùng một tác giả
White
2 0
Tăng dung lượng ổ cứng Box Vagrant Cách tăng dung lượng ổ cứng của box vagrant một cách đơn giản nhất Trước khi khi chạy lệnh vagrant up provisio...
Dần Huỳnh viết 12 ngày trước
2 0
White
2 0
Mô tả Quick Sort là một thuật toán sắp xếp hiệu quả dựa trên việc phân chia mảng thành các nhóm phần tử nhỏ hơn. Giải thuật sắp xếp nhanh chia mản...
Dần Huỳnh viết 12 ngày trước
2 0
Bài viết liên quan
White
49 5
Hiện nay, các ứng dụng viết theo mô hình RESTful API và SoftwareasaService (SaaS) ngày càng bùng nổ. Thế nên việc có 1 trang quản lý các api của mì...
Nguyễn Hoàng Hüy viết hơn 2 năm trước
49 5
{{like_count}}

kipalog

{{ comment_count }}

bình luận

{{liked ? "Đã kipalog" : "Kipalog"}}


White
{{userFollowed ? 'Following' : 'Follow'}}
3 bài viết.
2 người follow

 Đầu mục bài viết

Vẫn còn nữa! x

Kipalog vẫn còn rất nhiều bài viết hay và chủ đề thú vị chờ bạn khám phá!