PHP download

Download the PHP package suzunone/l-auto-comment-for-php-swagger without Composer

On this page you can find all versions of the php package suzunone/l-auto-comment-for-php-swagger. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download suzunone/l-auto-comment-for-php-swagger
More information about suzunone/l-auto-comment-for-php-swagger
Files in suzunone/l-auto-comment-for-php-swagger

Vendor suzunone
Package l-auto-comment-for-php-swagger
Short Description Automatically generate PHP Swagger comments from Laravel's Controller, Model, and form requests.
License MIT

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?

Example code of suzunone/l-auto-comment-for-php-swagger

Informations about the package l-auto-comment-for-php-swagger

Auto-generate SwaggerPHP comments from Laravel.

Description

Auto-generate Swagger-PHP comments from models. Automatically generate Swagger-PHP comments using routing, form requests, and small annotations.

Installation

Usage

openapi:info-comment
- Create OA\Info file
openapi:security-comment
- Create Security Setting file
openapi:create-model-to-schema
- Create Swagger-PHP schema file for models
openapi:file-to-annotation
- Create a comment definition from yaml or json
openapi:swagger-commen
- Automatically generate comments for Swagger-PHP

openapi annotation

Small annotations can be used instead of the very large Swagger-PHP format comments.

By writing in each method of Controller, Swagger-PHP style annotations are automatically generated from FormRequest and routing.

FormRequest

@property {TYPE} {VARIABLE NAME} {DESCRIPTION}
@property-read {TYPE} {VARIABLE NAME} {DESCRIPTION}

Describes the parameters to be received in the request, the same as property in PHP Doc
@openapi-in {REQUEST IN} {VARIABLE NAME} Specify the parameter location for the in field. If it is not specified, in="query" will be given.
@openapi-content {MIME} {FORMAT} {DESCRIPTION} When using request()->getContent(), you can specify the contents of content. You can specify more than one, but only one description will be used.

Controller

@openapi

Describes if you want to include the openapi:swagger-commen target.
@openapi-tags

Describe the API tag.

Can be multiple.

If omitted, it will be automatically generated from the controller name, etc.
@openapi-response {HTTP STATUS} {RESPONSE SCHEMA} {DESCRIPTION}

You can describe the response of the API.

Specify a pre-prepared schemas.

schemas can be nested.

Multiple entries can be made by changing the HTTP STATUS
@openapi-response-type {HTTP STATUS} {RESPONSE TYPE} {CONTENT TYPE}

The response type can be specified. You can choose from json xml media-type, and if you choose media-type, you can specify the content type. If there is more than one response type, multiple responses can be listed. If omitted, json will be used.
@openapi-ignore-session-cookie
@openapi-session-cookie

Toggle whether to use session cookies.
@openapi-ignore-csrf-header
@openapi-csrf-header

Toggle whether to use CSRF headers.
@openapi-security {securityScheme} {SCOPES(comma-separated)}
@openapi-security {Security setting json}

Security settings to use

A very simple example

Nest Response Usage

Single Nest

DeepNest

Schema pattern of auto-generated Model

Create{ModelName}

Excluding columns with auto-increment. Except for references to other models.

Create{ModelName}WithRelation

Excluding columns with auto-increment. Include references to other models.

{ModelName}

Include auto-incrementing columns. Except for references to other models.

{ModelName}WithRelation

Include auto-incrementing columns. Include references to other models.

{ModelName}Many

Array of models. Except for references to other models.

{ModelName}WithRelationMany

Array of models. Include references to other models.

{ModelName}Paginate

Pagination of models. Except for references to other models.

{ModelName}WithRelationPaginate

Pagination of models. Include references to other models.

All versions of l-auto-comment-for-php-swagger with dependencies

PHP Build Version

Package Version

Version v0.0.11 Release 15. Feb 2022
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of l-auto-comment-for-php-swagger from vendor suzunone

Requires barryvdh/laravel-ide-helper Version ^2.11
ext-mbstring Version *
ext-json Version *

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 suzunone/l-auto-comment-for-php-swagger contains the following files

Loading the files please wait ....