一个 Hyperf 框架的 Api 参数校验及 swagger 文档生成组件

最新推荐文章于 2024-06-03 09:49:31 发布
最新推荐文章于 2024-06-03 09:49:31 发布
阅读量2.1k 收藏
点赞数
分类专栏： hyperf 文章标签： php
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/gzyx1988/article/details/122232955
版权

组件代码地址

apidog/README.md at master · daodao97/apidog · GitHubApi Watch Dog, Hyperf 框架的 Api参数校验 和 swagger 生成组件. Contribute to daodao97/apidog development by creating an account on GitHub.https://github.com/daodao97/apidog/blob/master/README.md

一个 Hyperf 框架的 Api 参数校验及 swagger 文档生成组件

  1. 根据注解自动进行Api参数的校验, 业务代码更纯粹.
  2. 根据注解自动生成Swagger文档, 让接口文档维护更省心.

Swagger UI启动

本组件提供了两种方式来启用SwaggerUI , 当config/autoload/apidog.php enable = true 时

方式一

系统启动时, swagger.json 会自动输出到配置文件中定义的 output_file中, 此时我们到swagger ui的前端文件结合nginx启动web服务

方式二

也可以使用组件提供的快捷命令, 快速启动一个 swagger ui.

php bin/hyperf.php apidog:ui

php bin/hyperf.php apidog:ui --port 8888
守护在原地
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
hyperf-apihelper:hyperf api swagger helper -[api接口自动验证和swagger接口文档生成] 组件
05-08
hyperf-apihelper hyperf api and swagger helper. 它是一个框架的 [api接口自动验证和swagger接口文档生成] 组件. 功能包括： 通过注解定义接口路由、请求方法和参数,并由中间件自动校验接口参数. 生成json文件,供swagger接口文档测试使用,可打开或关闭. swagger支持接口多版本分组管理. 支持restful path路由参数校验. 支持自定义响应体结构. 支持自定义多层级swagger model. 支持自定义前置动作. 支持自定义拦截动作. 支持自定义后置动作. 0.安装 nginx(或apache)指定站点目录为 BASE_PATH/public, swagger-ui将自动发布到该目录下 安装组件 # composer安装本组件 composer require kakuilan/hyperf-apihelper
hyperf实用工具
qq_38234594的博客
12-14 1624
使用hyperf框架的小伙伴，研究这个框架三个多月了，感觉框架的响应速度真的非常棒，但是实用的工具还有些欠缺，我根据之前用的yii框架和laravel带来的灵感封装了一些工具，有使用hyperf框架的小伙伴可以看一下： hyperf-tool 功能 该组件主要是根据开发扩展一些hyperf的工具，主要有gii工具、swagger的扩展等… 持续跟进中。。。 下载安装包 composer require eric-strive/hyperf-tool 同步配置 php bin/hyperf.php ve
Hyperf 发布 v1.1.16 版本 | 企业级的 PHP 微服务云原生协程框架
weixin_41171606的博客
04-18 839
更新内容 本周更新主要为 gRPC 组件做了大量的优化工作和为一些组件增加了一些小功能使之更加好用，同时我们还修复了一些组件的 Bug，发布于 1.1.16 版，强烈建议使用到 gRPC、JSONRPC、AMQP、Consul 和 自定义进程 的用户更新。 直接访问 官网 hyperf.io 或 文档 hyperf.wiki 查看更新内容。 新增 #1263 为 async-queu...
初识Hyperf
zxh1873583的博客
08-26 4208
初识hyperf
hyperf中的设计模式（一）
qq_38961339的博客
08-29 960
hyperf简介 2.0 介绍 Hyperf 是基于 Swoole 4.5+ 实现的高性能、高灵活性的 PHP 协程框架，内置协程服务器及大量常用的组件，性能较传统基于 PHP-FPM 的框架有质的提升，提供超高性能的同时，也保持着极其灵活的可扩展性，标准组件均基于 PSR 标准 实现，基于强大的依赖注入设计，保证了绝大部分组件或类都是 可替换 与 可复用 的。 框架组件库除了常见的协程版的 MySQL 客户端、Redis 客户端，还为您准备了协程版的 Eloquent ORM、WebSocket 服务端及
hyperf框架基础建设：中间件（统一接口参数校验）
wangtianyou343的博客
11-24 691
hyperf框架基础建设：中间件（统一接口参数校验）
apidog:Api Watch Dog, Hyperf 框架的 Api参数校验 和 swagger 生成组件
05-31
Api Watch Dog 一个 框架的 Api 参数校验及 swagger 文档生成组件 根据注解自动进行Api参数的校验, 业务代码更纯粹. 根据注解自动生成Swagger文档, 让接口文档维护更省心. 在 1.2 版本后, 本扩展移除了内部自定义的验证器, 只保留的 hyperf 原生验证器, 以保持验证规则的统一 旧版本文档 安装 composer require daodao97/apidog 使用 1. 发布配置文件 php bin/hyperf.php vendor:publish daodao97/apidog # hyperf/validation 的依赖发布 php bin/hyperf.php vendor:publish hyperf/translation php bin/hyperf.php vendor:publish hyperf/validation 2
Hyperf自定义中间件之API签名认证
jobsen123的专栏
07-16 589
<?php declare(strict_types=1); namespace App\Middleware; use Psr\Container\ContainerInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestH.
SwaggerApi文档管理
香帅的博客
11-30 311
文件在E:\学习文档子目录压缩\框架\微服务相关\SwaggerApi文档管理\SwaggerApi文档管理.doc 或 我的网盘\我的笔记\学习文档子目录压缩\框架\微服务相关\SwaggerApi文档管理\SwaggerApi文档管理.doc xiangshuai-shop-f-service-api maven依赖最好放在接口服务中 引入Maven依赖 <!--...
hyperf-api:hyperf写api接口整理
04-04
一：env配置 调试和环境配置 mysql，redis，jwt，elasticsearch等配置 新建.env，.env.dev，.env.prod方便管理 #三个值：local, develop, production APP_DEBUG=true APP_ENV=local 二：公共类 1.约会公共并自动加载 #新建文件夹：辅助类, 性状, 工具类 app/common/Helpers app/common/Traits app/common/Utils #composer.json加入 "Common\\": "common" composer dumpautoload 2.辅助类 时间格式时间格式转换 验证器通用验证器 3.性状 JsonResponse接口响应json 4.工具类 DingDingRobot钉钉机器人 作曲家包 composer require ext-cur
markdown-swagger：将Swagger文件中的API文档生成为markdown文件
02-04
这将读取指定的swagger文件并生成一个表，该表描述目标markdown文件中的API。 markdown-swagger脚本将在目标markdown文件中寻找以下文本的内容： <!-- markdown-swagger --> Everything here will be ...
swagger:使用 Swagger 2.0 自动生成 RESTful API 文档的 Iris 中间件
05-29
用于 Iris Web 框架的 Swagger 中间件可按照要求使用 Swagger 2.0 自动生成 RESTful API 文档。用法开始使用它向您的 API 源代码添加注释，。 使用以下命令下载 for Go：$ go get -u github....
asp.net webapi集成swagger自动生成接口文档(亲测可用)
03-25
asp.net webapi集成swagger自动生成接口文档(亲测可用)swagger生成html离线接口文档swagger生成html离线接口文档
hyperf入门教程＜一＞hyperf的安装
划水小老虎的博客
05-08 4673
环境: centos7 php 7.3 一,下载安装包 进入官网 http://git.oschina.net/swoole/swoole点击这里 这里可以看到最新版本 是4.4.15 我们下载一个tar.gz文件 右键 复制链接 输入命令 wget https://gitee.com/swoole/swoole/repository/archive/v4.4.15?format=tar....
Hyperf框架 - 基于Json-Rpc与Consul的微服务搭建
猛犸象
07-31 4657
依赖的组件 hyperf/json-rpc hyperf/rpc-client hyperf/rpc-server hyperf/service-governance hyperf/consul 以 HTTP协议 为例 json-rpc 即为基于json的rpc调用，原理就是 A 和 B 拥有同一套 interface I 的定义，A 就像调用自己的方法一样调用B的方法F，当然F必须是 insterface I 中的方法。 保存镜像 docker commit -p hyperf raoxi
hyperf 实战之问答系统接口开发——概述（连载中）
白狼栈
11-11 419
这个系列我们主要讲什么呢? 我们主要模仿 http://funqas.com/ 这个网站，利用 hyperf 实现一套问答系统的接口开发，包括 hyperf 框架的搭建、各个功能模块的实现以及后期的部署，手把手教你如何基于 hyperf 框架进行开发。
【五一创作】Hyperf3.0框架在物联网中实际应用的分析与演示
PHP全栈狼的博客
05-03 1128
这是一篇为PHP的开发者们入门物联网的一个经验文章,尝试了解hyperf及swoole,能让你的技术栈得到更大的提升Hyperf是一款基于开发的，它在物联网应用中具有广泛的应用场景。本文将介绍Hyperf在物联网中的运用，以及对其性能的分析和优化。
内部类 参数校验
meser88的博客
04-08 1041
package com.ecarx.ads.processstore.domain.dto; import com.ecarx.ads.processstore.domain.annotation.OutFormatValidator; import lombok.Data; import javax.validation.Valid; import javax.validation.constraints.NotBlank; import javax.validation.constraints.N.
【全开源】旅游门票预订系统（FastAdmin+ThinkPHP+Uniapp）
最新发布
2401_84413757的博客
06-03 262
一款基于FastAdmin+ThinkPHP+Uniapp开发的旅游门票预订系统，支持景点门票、导游产品便捷预订、美食打卡、景点分享、旅游笔记分享等综合系统，提供前后台无加密源码，支持私有化部署。 ​便捷你的每一次出行🌍 🌟 轻松预订，说走就走 🎒 每当计划一场旅行，最让人头疼的莫过于门票的预订。传统的排队购票不仅浪费时间，还可能因为售罄而错过心仪的景点。而现在，有了旅游门票预订系统，一切变得简单而高效。📱只需动动手指，就能轻松预订心仪的景点门票，说走就走，不再受时间和地点的限制。 🌈 全面覆盖，任
提供一个将swagger文档逆向生成Java代码的具体实现步骤
06-13
将Swagger文档逆向生成Java代码的具体实现步骤如下： 1. 下载Swagger Codegen工具，可以从官网下载，也可以从GitHub上下载源码自行...需要注意的是，生成的代码只是一个框架，需要根据实际业务需求进行调整和完善。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

守护在原地

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值