ansjabar/laradocs

使用DocBlocks为您的Laravel应用程序生成漂亮的文档。

维护者

详细信息

github.com/ansjabar/laradocs

源代码

问题

安装: 22

依赖项: 0

建议者: 0

安全: 0

星星: 2

关注者: 1

分支: 0

开放问题: 0

0.1.2 2022-09-22 10:01 UTC

MIT f1820af14261e20dc53052eaac8ce5596a4cd205

  • Ans Jabar <ans.jabar.woop@gmail.com>

documentationapiannotationdocslaravel

This package is auto-updated.

Last update: 2024-09-22 15:46:30 UTC

README

LaraDocs

使用DocBlocks为您的Laravel应用程序生成漂亮的文档。

LaraDocs

LaraDocs 是一个简单的代码驱动包，它提供了一个简单的方法，在您的Laravel应用程序内为您的产品或应用程序创建漂亮的文档。

入门指南

☝️ 通过composer安装包。

composer require ansjabar/laradocs

✌️ 运行以下命令以发布资源和配置文件 laraadoc.php

php artisan vendor:publish --provider="AnsJabar\LaraDocs\LaraDocsServiceProvider"

✌️ 运行以下命令生成文档

php artisan laradocs:generate

访问您的应用程序域名，并带有 /laradocs 端点。就是这样。

使用示例

<?php

/**
 * @title User Management
 * @description This is user management group description
 */
class UserController
{
	/**
	 * @title Login
	 * @description Login description goes here
	 * @method GET
	 * @queryParams param1 required Number param description
	 * @queryParams param2 optional Number param description
	 * @dataParams param1 required Number param description
	 * @dataParams param2 optional Number param description
	 * @headers header1 required Number param description
	 * @headers header2 optional String param description
	 * @successData {"name":"John", "age":31, "city":"New York"}
	 * @failureErrors {"message":"Something went wront"}
	 */
	public function login()
	{

	}
}

注意

此包将解析在 RouteServiceProvider.php 中映射的所有路由文件。闭包路由将被忽略。

许可

此包根据MIT许可进行许可 - 详细信息请参阅LICENSE.md文件。