Download the PHP package dasher/webman-docs without Composer

On this page you can find all versions of the php package dasher/webman-docs. 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 webman-docs

Dasher Webman Docs

一个为 Webman 框架设计的自动 API 文档生成器,界面参考 Apifox 和 Hoppscotch。

特性

安装

安装后会自动完成以下操作:

  1. 复制配置文件到 config/plugin/dasher/webman-docs/
  2. 注册路由
  3. 复制公共资源文件

无需任何手动配置,开箱即用!

快速开始

1. 在控制器中添加注解

2. 访问文档

浏览器访问:http://your-domain/api-docs

就这么简单!✨

注解说明

注解 说明 使用位置
@Api\Group 定义 API 分组 类
@Api\Endpoint 定义 API 端点 方法
@Api\QueryParam URL 查询参数 方法
@Api\BodyParam 请求体参数 方法
@Api\Header 请求头参数 方法
@Api\Response 响应定义 方法
@Api\Auth 认证配置 类/方法

配置选项

配置文件位于 config/plugin/dasher/webman-docs/app.php:

命令行工具

示例代码

查看 examples/ 目录获取完整的控制器示例:

截图预览

UI 界面采用现代化的设计风格:

环境要求

常见问题

Q: 安装后访问 /api-docs 404?

A: 确保 Webman 已重启,检查路由是否正确加载。

Q: 注解不生效?

A: 确认使用了正确的命名空间 Dasher\WebmanDocs\Annotation,并检查 PHP 版本 >= 8.0。

Q: 支持 Webman 2.x 吗?

A: 是的,完全支持 Webman 1.x 和 2.x。

Q: 如何启用认证保护?

A: 修改配置文件中的 auth.enabled 为 true,并设置 token。

更多文档

GitHub

https://github.com/syjbd/phpdoc

License

MIT


All versions of webman-docs with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
workerman/webman-framework Version ^1.0|^2.0
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 dasher/webman-docs contains the following files

Loading the files please wait ...