Download the PHP package avrilko/apidocs without Composer

On this page you can find all versions of the php package avrilko/apidocs. 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?

Example code of avrilko/apidocs

Informations about the package apidocs

PHP Swagger Api Docs

基于 Hyperf 框架的 swagger 文档生成组件，支持swoole/swow驱动

优点

使用须知

例子

请参考example目录

安装

使用

1. 发布配置文件

1.1 配置信息

config/autoload/api_docs.php

2. 直接启动框架(需要有http服务)

看到Swagger Url显示，表示文档生成成功，访问/swagger即可以看到swagger页面

3. 使用

注解

命名空间:Hyperf\DTO\Annotation\Contracts

[RequestBody]

[RequestQuery]

[RequestFormData]

[ApiSecurity] 注解

注意: 一个方法，不能同时注入RequestBody和RequestFormData

示例

控制器

验证器

基于框架的验证

安装hyperf框架验证器hyperf/validation, 并配置(已安装忽略)

只需在控制器方法中加上 #[Valid] 注解

自定义注解验证

注解的验证支持框架所有验证, 组件提供了常用的注解用于验证

  1. 使用自定义验证注解, 创建注解类继承Hyperf\DTO\Annotation\Validation\BaseValidation
  2. 重写$rule属性或getRule方法

注意

数组类型的问题

PHP原生暂不支持int[]或Class[]类型, 使用示例

hyperf 2.2版本报错

@required注解会提示报错,请忽略required

修改文件config/autoload/annotations.php

AutoController注解

控制器中使用AutoController注解,只收集了POST方法

Swagger界面

hMvJnQ

All versions of apidocs with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
tangwei/swagger-ui Version ^4.6
tangwei/dto Version ~2.1.0
zircote/swagger-php Version ^4.5
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 avrilko/apidocs contains the following files

Loading the files please wait ....