hidayat/api-docs

此包提供了REST API的文档

dev-master 2022-09-11 17:07 UTC

This package is auto-updated.

Last update: 2024-09-11 21:12:39 UTC


README

此包提供了一个简单的方法来生成Laravel中API的文档

composer require hidayat/api-docs

使用方法

安装后,使用以下命令发布包:
php artisan vendor:publish --provider="Hidayat\ApiDocs\RestApiDocServiceProvider"

  • 发布后,你将在config/目录下找到一个名为api_docs的配置文件,它将包含一个API端点文档的示例。你可以使用该示例添加其他端点。
  • 接下来,将以下代码粘贴到你的routes/web.php文件中:
  • 你可以在其他路由文件中的任何位置放置它,只要该文件被加载到路由中。
  • \Hidayat\ApiDocs\ApiDocsRoute::generateRoute();
  • 这将创建一个名为api_docs的route URL,访问此URL,你将看到文档视图。
  • 运行发布命令后,包使用的视图也将发布到resources/views/vendor/api_docs文件夹,你可以在那里进行自定义。
  • 如果你想为文档使用不同的URL,可以将url传递给\Hidayat\ApiDocs\ApiDocsRoute::generateRoute('custom-url');,这将用作显示文档的URL而不是默认URL。
  • 视图使用的样式也发布到public/vendor/api_docs文件夹,你可以根据需要更改样式。
  • 注意:此包扫描所有前缀为api的路由,其他路由保持不变。