Download the PHP package laravel-toolbox/swagger-notes without Composer

On this page you can find all versions of the php package laravel-toolbox/swagger-notes. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package swagger-notes

Laravel 開發工具箱之 SwaggerNotes 生成工具

註:該工具僅生成注釋內容,依賴 swagger-php 包才能生成 .yaml 接口文件

  1. 本地開發環境安裝依賴包

  2. 請在 Controller 類中對應的方法 return 前,加入如下代碼:

  3. 新增可支持擴展字段的備註信息,在調用類中新增&修改如下代碼即可:

  4. 默認生成路徑在swagger/SwaggerNotes目錄下,層級結構如下:

  5. 附表

    方法 釋義 可选 備註
    setRequest 設置請求體,可解析出當前接口的methodparameterurlpathInfo ✔️ 第二個形參可选,支持被改造的Request請求體,如:new GetAffiliateParameter($request)
    setResponse 設置返回體,可直接給返回的數組結構
    setComments 設置字段的備註、規則等 ✔️ 接口字段涉及的表集合;驗證規則,不設置則取->rules()
    setApiInfo 設置 API_INFO 的相關參數
    summary 設置當前接口文檔的summary概述信息 ✔️ 不設置則取->name()
    description 設置當前接口文檔的description描述信息 ✔️
    operation_id 設置當前接口文檔的操作ID標識 建議__FUNCTION__
    tags 設置當前接口文檔的標籤分類 建議__CLASS__
    generate 生成文檔 僅本地、測試環境或開啟 debug 模式時生效

All versions of swagger-notes with dependencies

PHP Build Version
Package Version
Requires php Version ^7.1||^8.0.2||^8.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package laravel-toolbox/swagger-notes contains the following files

Loading the files please wait ....