Skip to content

TELstatic/thresh

Repository files navigation

Thresh

Laravel API 文档生成器,可以将基于 Laravel 项目的项目代码,自动生成 json 或 md 格式的描述文件。

StyleCI Shield licence licence code size downloads downloads downloads

安装

$ composer require telstatic/thresh -vvv

功能

  1. 生成 Markdown 文档
  2. 生成 Postman 配置文件
  3. 生成 Swagger 配置文件

使用示例

详见 TELstatic\Thresh\Controllers\ThreshController 安装扩展后,访问 http://{your-domain}/thresh

Contributing

You can contribute in one of three ways:

  1. File bug reports using the issue tracker.
  2. Answer questions or fix bugs on the issue tracker.
  3. Contribute new features or update the wiki.

The code contribution process is not very formal. You just need to make sure that you follow the PSR-0, PSR-1, and PSR-2 coding guidelines. Any new code contributions must be accompanied by unit tests where applicable.

License

MIT

Thanks

About

Laravel API 文档生成器,可以将基于 Laravel 项目的项目代码,自动生成 json 或 md 格式的描述文件。

Resources

Stars

Watchers

Forks

Packages

No packages published