laravel如何生成swagger接口文档

php artisan serve --host 0.0.0.0
php artisan serve --port 8080

地址:
http://127.0.0.1/blogkjh/public/api/documentation

1、安装包

composer require darkaonline/l5-swagger

2、配置

php artisan vendor:publish --provider “L5Swagger\L5SwaggerServiceProvider”

3、启动服务

php artisan serve

刚开始启动会报错,因为还没有写注释文档

注释文档可以这样写

/*** @OA\Info(title="查询api", version="0.1")*//*** @OA\Get(*     path="/article",*     @OA\Response(response="200", description="An example resource")* )*/

然后命令行输入:

php artisan l5-swagger:generate

在这里插入图片描述
生成
在这里插入图片描述
关于注释:
@SWG,现在最新版本使用的是 @OA 做为标识

标题添加参数

/*** @OA\Post(*     path="/article",*     summary="Adds a new user",*     @OA\RequestBody(*         @OA\MediaType(*             mediaType="application/json",*             @OA\Schema(*                 @OA\Property(*                     property="title",*                     type="string"*                 ),*                 @OA\Property(*                     property="content",*                     type="string"*                 ),*                 example={"title": "a3fb6", "content": "Jessica Smith"}*             )*         )*     ),*     @OA\Response(*         response=200,*         description="OK"*     )* )*/

热更新
全局搜索generate_always

'generate_always' => env('L5_SWAGGER_GENERATE_ALWAYS', false),改为true即可

增加请求体里的内容:

概览

@OA\Parameter(name="userId", in="query", @OA\Schema(type="intger"), required=true, description="用户ID"),

in

in中的内容可以是query也可以是path

单个api介绍:

summary="根据 ID 获取文章信息",

标签分类

tags={"用户管理"},

参考博客:
https://learnku.com/articles/37313

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/322656.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

jzoj4673,CF578D-LCS again【统计,字符串,容斥】

正题 luoguluoguluogu题目链接:https://www.luogu.org/problemnew/show/CF578D 题目大意 求有多少个字符串TTT使得其和字符串SSS的LCSLCSLCS长度为∣S∣−1|S|-1∣S∣−1 解题思路 首先考虑挖一个空再填一个字母。 这样方案数为n∗n∗mn*n*mn∗n∗m 但是我们考虑aabaabaab这样…

OAuth2 实现单点登录 SSO

转载自 OAuth2 实现单点登录 SSO 1. 前言 技术这东西吧,看别人写的好像很简单似的,到自己去写的时候就各种问题,“一看就会,一做就错”。网上关于实现SSO的文章一大堆,但是当你真的照着写的时候就会发现根本不是那么…

Ocelot网关

Ocelot是一个.net core框架下的网关的开源项目,下图是官方给出的基础实现图,即把后台的多个服务统一到网关处,前端应用:桌面端,web端,app端都只用访问网关即可。 Ocelot的实现原理就是把客户端对网关的请求…

linux服务器部署laravel出现putenv() has been disabled for security reasons

putenv() has been disabled for security reasons 进入 www/serve/php/72/etc 找到 disable_functions后面的函数,删除 putenv() 如果报错 The Process class relies on proc_open, which is not available on your PHP installation. 删除 proc_open

欢乐纪中A组周六赛【2019.3.23】

前言 做A组被虐好惨 成绩 RankRankRank是有算别人的 RankRankRankPersonPersonPersonScoreScoreScoreAAABBBCCC1313132017WYC2017WYC2017WYC1901901909090901001001000001919192017HZB2017HZB2017HZB1101101101001001001010100002727272017XJQ2017XJQ2017XJQ10010010010010010…

百度OCR文字识别-身份证识别

简介 答应了园区大牛张善友 要写AI 的系列博客,所以开始了AI 系列之旅。 一、介绍 身份证识别 API 接口文档地址:http://ai.baidu.com/docs#/OCR-API/top 接口描述 用户向服务请求识别身份证,身份证识别包括正面和背面。 请求说明 请求示例…

Spring Boot Elasticsearch 入门

转载自 芋道 Spring Boot Elasticsearch 入门 1. 概述 如果胖友之前有用过 Elasticsearch 的话,可能有过被使用的 Elasticsearch 客户端版本搞死搞活。如果有,那么一起握个抓。所以,我们在文章的开始,先一起理一理这块。 Elas…

内存不足The following exception is caused by a lack of memory or swap, or not having swap

在linux执行以下三个命令即可 /bin/dd if/dev/zero of/var/swap.1 bs1M count1024 /sbin/mkswap /var/swap.1 /sbin/swapon /var/swap.1

P2513-[HAOI2009]逆序对数列【dp,前缀和】

正题 题目链接:https://www.luogu.org/problemnew/show/P2513 题目大意 求长度为nnn逆序对为kkk个的序列总数。 解题思路 设fi,jf_{i,j}fi,j​表示1∼i1\sim i1∼i的排列逆序对个数为jjj 然后显然:fi,j∑k1i−1fi−1,j−kf_{i,j}\sum_{k1}^{i-1}f_{i-1,j-k}fi,j​k1∑i−1​…

在.NET Core类库中使用EF Core迁移数据库到SQL Server

前言 如果大家刚使用EntityFramework Core作为ORM框架的话,想必都会遇到数据库迁移的一些问题。 起初我是在ASP.NET Core的Web项目中进行的,但后来发现放在此处并不是很合理,一些关于数据库的迁移,比如新增表,字段&…

Spring Boot MongoDB 入门

转载自 芋道 Spring Boot MongoDB 入门 1. 概述 可能有一些胖友对 MongoDB 不是很了解,这里我们引用一段介绍: FROM 《分布式文档存储数据库 MongoDB》 MongoDB 是一个介于关系数据库和非关系数据库之间的产品,是非关系数据库当中功能最…

composer配置阿里云镜像

composer config -g repo.packagist composer https://mirrors.aliyun.com/composer/

CF735D-Taxes【数学,数论】

正题 luogu题目链接:https://www.luogu.org/problemnew/show/CF735D 题目大意 将一个数分解成若干个数使得这若干个数的最大因子最小。 解题思路 如果是质数就是1。如果是偶数根据哥德巴赫猜想就是2。或者把一个奇数减去2后是个质数也是2。否则就是3。 codecodecode #inclu…

Spring框架-事务管理注意事项

转载自 Spring框架-事务管理注意事项 常见事务问题 事务不起作用 可能是配置不起效,如扫描问题 事务自动提交了(批量操作中) 可能是在没事务的情况下,利用了数据库的隐式提交 事务配置说明 通常情况下我们的Spring Component扫…

P2568-GCD【欧拉函数,欧拉筛】

正题 题目链接:https://www.luogu.org/problemnew/show/P2568 题目大意 求有多少个数对满足gcd(x,y)pri(x,y≤n)gcd(x,y)pri(x,y\leq n)gcd(x,y)pri(x,y≤n) 解题思路 首先对于 gcd(x,y)pgcd(x,y)pgcd(x,y)p >gcd(x/p,y/p)1>gcd(x/p,y/p)1>gcd(x/p,y/p)1 那么对数就…

laravel允许所有网站进行跨域操作

共三步&#xff1a; 1、新建中间件&#xff1a; php artisan make:middleware EnableCrossRequestMiddleware2、EnableCrossRequestMiddleware.php中重写中间件里面的内容&#xff1a; <?php namespace App\Http\Middleware; use Closure; class EnableCrossRequestMidd…

Ocelot统一权限验证

Ocelot作为网关&#xff0c;可以用来作统一验证&#xff0c;接上一篇博客Ocelot网关&#xff0c;我们继续 前一篇&#xff0c;我们创建了OcelotGateway网关项目&#xff0c;DemoAAPI项目&#xff0c;DemoBAPI项目&#xff0c;为了验证用户并分发Token&#xff0c;现在还需要添…

P1081-开车旅行【倍增,链表,dp】

正题 题目大意:https://www.luogu.org/problemnew/show/P1081 题目大意 有若干个城市有不同的海拔hhh&#xff0c;两个城市之间的距离定义为∣hx−hy∣|h_x-h_y|∣hx​−hy​∣ 小A每次走次近的&#xff0c;小B每次走最近的。它们轮流开车。且只会往编号更大的城市开。 问一:…

Spring Boot之程序性能监控

转载自 Spring Boot之程序性能监控 Spring Boot特别适合团队构建各种可快速迭代的微服务&#xff0c;同时为了减少程序本身监控系统的开发量&#xff0c;Spring Boot提供了actuator模块&#xff0c;可以很方便的对你的Spring Boot程序做监控。 1. actuator接口说明 Spring B…

laravel部署在linux出现404 not found

laravel项目放在本地服务器后&#xff0c;访问是成功的 http://localhost/blogkjh/public/article 但是在linux服务器上访问显示404 not found 但是我在服务器上使用 php artisan serve --host 0.0.0.0 命令 却可以访问 甚至连swagger都可以访问 关于这个我最近就特别疑…