最近发现一个问题,使用showdoc无法使用在laravel框架上,所以就要找一个新的方式
之前使用的laravel-apidoc的库也有一年多没更新了,无法使用在laravel8上面
所以我们就使用showdoc也支持的swagger进行处理

技术选型swagger

安装swagger到laravel中

composer require "darkaonline/l5-swagger" //目前是最新的
php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"

生成文档

php artisan l5-swagger:generate

注释的语法

语法

官方文档OpenAPI Specification:https://swagger.io/specification/

Swagger-PHP v3.xhttps://zircote.github.io/swagger-php/

@OA\Info

一个项目中只能放着一个.

/*** @OA\Info(*     title="Auth api",*     version="0.0.1"* )*/

@OA\Get

还差这个地方的说明

/*** @OA\Get(*     path="/projects",*     @OA\Response(response="200", description="Display a listing of projects.")* )*/

[laravel]laravel8自动生成api文档相关推荐

springboot 集成 swagger 自动生成API文档
Swagger是一个规范和完整的框架,用于生成.描述.调用和可视化RESTful风格的Web服务.简单来说,Swagger是一个功能强大的接口管理工具,并且提供了多种编程语言的前后端分离解决方案. S ...
【接口文档】Django restful framework中自动生成API文档
Django restful framework中自动生成API文档一.Swagger概述 1.引言当接口开发完成,紧接着需要编写接口文档.传统的接口文档使用Word编写,or一些接口文档管理平台 ...
swagger php修改成中文,PHP使用swagger自动生成API文档
使用 swagger 自动生成 API 文档使用 swagger 自动生成 API 文档,有需要的朋友可以参考下. 一.下载 swagger-ui 直接上传服务器二.下载 swagger-php ...
SpringBoot 自动生成API文档
SpringBoot 自动生成API文档在做项目的时候,如果项目是前后分离的,后端一定要和前端或者是移动端对接接口,那么问题来了,接口是不是要自己写给他们看,一般的会采用Excel或者Word来写, ...
超详细！使用swagger自动生成Api文档（swagger-ui）
介绍 swagger是什么? swagger-ui 使用swagger-ui 简单使用 swagger api注解本文参考: 介绍这里是一些介绍,如果想直接看如何使用,请直接跳过这部分.但如果有时 ...
windows api中文文档_Web服务开发：Spring集成Swagger，3步自动生成API文档
目录: 1,Spring Boot集成Swagger 2,Swagger接口文档页面 3,常见问题和解决方法在Sping开发REST接口服务时,API文档是不可缺少的一个重要部分.Swagger框架 ...
swagger 修改dto注解_Web服务开发：Spring集成Swagger，3步自动生成API文档
目录: 1,Spring Boot集成Swagger 2,Swagger接口文档页面 3,常见问题和解决方法在Sping开发REST接口服务时,API文档是不可缺少的一个重要部分.Swagger框架 ...
PHP使用swagger-php自动生成api文档（详细附上完整例子）
thinkphp5结合swagger自动生成接口文档整体介绍 swagger-php.swagger-ui.swagger-editor swagger-ui:主要就是放到tp项目public目录下 ...
如何利用showdoc自动生成API文档
介绍 showdoc是一个适合IT团队的文档工具,阅读本文前需要对showdoc有基本了解 .基本介绍可看:https://www.showdoc.cc/help 对于写API文档这件事,虽然说文本编 ...

[laravel]laravel8自动生成api文档

技术选型swagger

安装swagger到laravel中

生成文档

语法

@OA\Info

@OA\Get

[laravel]laravel8自动生成api文档相关推荐

最新文章

热门文章