当前位置：首页 > news >正文

tp6 + swagger 配置文档接口

news 文章来源：https://blog.csdn.net/junjiahuang/article/details/133319228 2025/1/12 8:46:09

ThinkPHP 6.0

运行环境要求PHP7.2+，兼容PHP8.1

安装

composer create-project topthink/think tp 6.0.*

如果需要更新框架使用

composer update topthink/framework

文档

完全开发手册

swagger

文档

注解文档

安装包

composer require zircote/swagger-php

引用swagger-ui

下载ui

git clone https://github.com/swagger-api/swagger-ui.git

下载到public下,后续访问要使用到。

可以重命名，比如apidoc。

修改swagger-ui/dist/index.html

window.onload = function() {window.ui = SwaggerUIBundle({url: "/localhost:8000/swagger.json",dom_id: '#swagger-ui',deepLinking: true,presets: [SwaggerUIBundle.presets.apis,SwaggerUIStandalonePreset],plugins: [SwaggerUIBundle.plugins.DownloadUrl],layout: "StandaloneLayout"});
};

生成`swagger.json`

第一种方式，手动命令行生成

./vendor/bin/openapi ./app/controller -o ./public/swagger.json

第二种方式，调用方法

建立路由

route/app.php

Route::group("index", function () {Route::rule('doc/[:isToJson]', 'doc');Route::rule('hello/[:name]', 'hello');Route::rule('index', 'index');
});

控制器
app/controller/Index.php

注释文档示例

<?php
namespace app\controller;use app\BaseController;
use OpenApi\Annotations as OA;
use think\facade\View;/*** @OA\Info(title="My First API", version="0.1")*/
class Index extends BaseController
{/*** @OA\Get(*     path="/index/index",*     tags={"index"},*     summary="接口名称",*     description="接口描述",*     @OA\Response(response="200", description="An example resource")* )*/public function index(){return view("index");}/*** @OA\Get(*     path="/index/hello/:name",*     tags={"index"},*     summary="输出hello+谁",*     @OA\Parameter(*         in="query",*         required=true,*         name="name",*         @OA\Schema(type="string"),*         description="名称"*     ),*     @OA\Response(response="200", description="An example resource")* )*/public function hello($name = 'ThinkPHP6'){return 'hello,' . $name;}public function doc(bool $isToJson = false){$openapi = \OpenApi\Generator::scan(['../app/controller']);header('Content-Type: application/x-json');if($isToJson) {return $openapi->toJson();}$res = file_put_contents('../public/swagger.json', $openapi->toJson());if ($res !== false) {
//            return redirect("localhost:${port}/docapi/index.html?port=${port}&docapi=${docapi}");return view();}return '没有文档';}// 空控制器public function __call($method, $args) {return 'error request';}
}

配置模板全局变量
config/view.php 最后加上

'tpl_replace_string' => ['__SWAGGER__' => '/swagger-ui/dist/']

__SWAGGER__在下面的doc.html里面使用到

视图
view/index/doc.html

<!DOCTYPE html>
<html lang="en">
<head><meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /><metaname="description"content="SwaggerUI"/><title>SwaggerUI</title><link rel="stylesheet" type="text/css" href="__SWAGGER__/swagger-ui.css" /><link rel="stylesheet" type="text/css" href="__SWAGGER__/index.css" />
</head>
<body>
<div id="swagger-ui"></div>
<script src="__SWAGGER__/swagger-ui-bundle.js" charset="UTF-8"> </script>
<script src="__SWAGGER__/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
<script src="__SWAGGER__/swagger-initializer.js" charset="UTF-8"> </script>
<script>window.onload = () => {window.ui = SwaggerUIBundle({url: location.origin + '/swagger.json',dom_id: '#swagger-ui',deepLinking: true,presets: [SwaggerUIBundle.presets.apis,SwaggerUIStandalonePreset],plugins: [SwaggerUIBundle.plugins.DownloadUrl],layout: "StandaloneLayout"});};
</script>
</body>
</html>

在这里插入图片描述

tp6 + swagger 配置文档接口

ThinkPHP 6.0 运行环境要求PHP7.2，兼容PHP8.1 安装 composer create-project topthink/think tp 6.0.*如果需要更新框架使用 composer update topthink/framework文档完全开发手册 swagger 文档注解文档安装包 composer require zircote/swagger-php 引用…...

编程日记 2023/9/30 7:38:24

试图一文彻底讲清 “精准测试”

在软件测试中，我们常常碰到两个基本问题（困难）： 很难保障无漏测：我们做了大量测试，但不清楚测得怎样，对软件上线后会不会出问题，没有信心； 选择待执行的测试用例&#…...

编程日记 2023/9/30 7:37:23

Visual Studio 删除行尾空格

1.CtrlH 打开替换窗口（注意选择合适的查找范围） VS2010: VS2017、VS2022: 2.复制下面正则表达式到上面的选择窗口(注意前面有一个空格)： VS2010: $ VS2017、VS2022: $ 3.下面的替换窗口不写入 VS2010: VS2017、VS2022: 4.点选“正则表达式…...

编程日记 2023/9/30 7:34:19

LeetCode_BFS_中等_1926.迷宫中离入口最近的出口

目录 1.题目2.思路3.代码实现（Java） 1.题目给你一个 m x n 的迷宫矩阵 maze （下标从 0 开始），矩阵中有空格子（用 ‘.’ 表示）和墙（用 ‘’ 表示）。同时给你迷宫的入口 …...

编程日记 2023/9/30 7:33:18

开源Windows12网页版HTML源码

开源Windows12网页版HTML源码，无需安装就能用的Win12网页版来了Windows12概念版（PoweredbyPowerPoint）后深受启发，于是通过使用HTML、CSS、js等技术做了这样一个模拟板的Windows12系统，并已发布至github进行开源。这…...

编程日记 2023/9/30 7:32:16

vscode中使用指定路径下的cmake

在 Visual Studio Code 中指定自定义的 CMake 路径，你可以通过以下步骤来实现： 打开你的 CMake 项目所在的文件夹，在 Visual Studio Code 中。在项目文件夹中，创建一个名为 .vscode 的文件夹，如果它还不存在。在 .…...

编程日记 2023/9/30 7:31:16

复杂度分析

文章目录如何分析、统计算法的执行效率和资源消耗？为什么需要复杂度分析？测试结果非常依赖测试环境测试结果受数据规模的影响很大大O复杂度表示法时间复杂度分析只关注循环次数最多的一段代码加法法则：总复杂度等于量级最大的那段代码的复杂…...

编程日记 2023/9/30 7:28:13

Linux安装jrockit-jdk1.6.0_29-R28.2.0-4.1.0-linux-x64

下载软件：jrockit-jdk1.6.0_29-R28.2.0-4.1.0-linux-x64.bin 执行安装 ./jrockit-jdk1.6.0_29-R28.2.0-4.1.0-linux-x64.bin 安装提示，一路next，注意第二步修改安装的路径，请修改成： <------------------------ O…...

编程日记 2023/9/30 7:26:11

7.2 怎样定义函数

7.2.1 为什么要定义函数主要内容： 为什么要定义函数 C语言要求所有在程序中用到的函数必须“先定义，后使用”。这是因为在调用一个函数之前，编译系统需要知道这个函数的名字、返回值类型、功能以及参数的个数与类型。如果没有事先定义&…...

编程日记 2023/9/30 7:25:10

Chrome扩展V2到V3的变化

Chrome扩展manifest V3变化、升级迁移指南_chrome_ZK645945-华为云开发者联盟 (csdn.net) 1.background //V2 "background": "background.js"//V3 "background": {"service_worker": "background.js"} 2.executeScript …...

编程日记 2023/9/30 7:22:07

lock、tryLock、lockInterruptibly有什么区别？

lock、tryLock 和 lockInterruptibly 都是用于线程同步的方法，但它们有不同的行为和用途： lock() 方法：lock() 方法是 Java 中 Lock 接口定义的一部分，它用于获取锁并阻塞当前线程，直到锁可用为止。如果锁当前被其他线程占用，lock() 方法会导致当前线程阻塞，直到锁被释放…...

编程日记 2023/9/30 7:19:02

mysql面试题5：索引、主键、唯一索引、联合索引的区别？什么情况下设置了索引但无法使用？并且举例说明

该文章专注于面试，面试只要回答关键点即可，不需要对框架有非常深入的回答，如果你想应付面试，是足够了，抓住关键点面试官：说一说索引、主键、唯一索引、联合索引的区别？索引、主键、唯一索引和联合索引是数据库中常用的索引类型，它们有以下区别：索引：索引是一种数…...

编程日记 2023/9/30 7:17:01

数据集笔记：纽约花旗共享单车od数据

花旗共享单车公布的其共享单车轨迹数据，包括2013年-2021年曼哈顿、布鲁克林、皇后区和泽西城大约14500辆自行车和950个站点的共享单车轨迹数据数据地址：Citi Bike System Data | Citi Bike NYC | Citi Bike NYC 性别（0未知；1男&…...

编程日记 2023/9/30 7:14:59

为什么 0.1+0.2 不等于 0.3

为什么 0.10.2 不等于 0.3 在 JavaScript 中，0.1 0.2 的结果不等于 0.3，这是因为在 JavaScript 中采用的是双精度浮点数格式（64 位），而在这种格式下无法精确表示某些小数，因此在进行计算时会出现精度误差。…...

编程日记 2023/9/30 7:11:56

huggingface_hub v0.17 现已发布

InferenceClient 现在支持所有任务！💥，感谢社区的巨大努力，新添加的任务包括： 对象检测文本分类Token 分类翻译问题回答表格问题回答填充掩码表格分类表格回归文档问题回答视觉问题回答零样本分类这些方法还支持使用 …...

编程日记 2023/9/30 7:09:55

机器学习——一元线性回归构造直线，并给出损失函数

目录 Question 问题分析 1.概念补充 2.流程分析 3.注意具体实现最终成果代码思考： Question 在二维平面有n个点，如何画一条直线，使得所有点到该直线距离之和最短如果能找到，请给出其损失函数问题分析 1.概念…...

编程日记 2023/9/30 7:05:50

OpenHarmony自定义组件介绍

一、创建自定义组件在ArkUI中，UI显示的内容均为组件，由框架直接提供的称为系统组件，由开发者定义的称为自定义组件。在进行 UI 界面开发时，通常不是简单的将系统组件进行组合使用，而是需要考虑代码可复用性、业务逻辑…...

编程日记 2023/9/30 7:04:49

云原生之使用Docker部署PDF多功能工具Stirling-PDF

云原生之使用Docker部署PDF多功能工具Stirling-PDF 一、Stirling-PDF介绍1.1 Stirling-PDF简介1.2 Stirling-PDF功能二、本次实践规划2.1 本地环境规划2.2 本次实践介绍三、本地环境检查3.1 检查Docker服务状态3.2 检查Docker版本3.3 检查docker compose 版本四、下载Stirli…...

编程日记 2023/9/30 7:03:48

B树和B+树的介绍和对比，以及MySQL为何选择B+树

在计算机科学中，B树和B树是常用的数据结构，用于在大规模数据集上进行高效的插入、删除和查找操作。它们在数据库管理系统、文件系统等许多实际应用中发挥着重要作用。本文将深入介绍B树和B树的结构特点、实际应用方面以及它们的优缺点，并最后…...

编程日记 2023/9/30 7:02:47

MD5 绕过第一式：弱比较绕过

文章目录参考环境MD5韧性脆弱性md5() 隐式类型转换字符串连接数学运算布尔判断相等运算符科学计数法科学计数法前缀 0E 与 0e PHP8 与 PHP 其他版本下字符串转化为数值的具体规则PHP8数值字符串优化其他版本更为详细的讲解字符串与字符串的弱比较字符串与数值的弱比较0e215…...

编程日记 2023/9/30 7:01:46

红黑树是如何实现的？

文章目录一、红黑树的概念二、红黑树的性质三、红黑树和AVL树对比四、红黑树的插入1. 红黑树的结点定义2. 父亲的颜色3. 叔叔的颜色为红色4. 叔叔不存在5. 叔叔存在且为黑6. 插入的抽象图五、红黑树的验证1. 检查平衡2. 计算高度与旋转次数3. 验证六、红黑树与AVL树的比较 …...

编程日记 2023/9/30 6:55:41

实验室没人导该怎么办

实验室没人教该怎么办 Q：国内top5高校研一，课题开始老板就给了一个大方向，之后怎么做实验都是自己看文献研究的，终于开始动手做实验，才发现别人根本不想管你，宁愿抱着电脑看剧也不想教你，十分焦虑，该怎么办？ A：按照大多数实验室的惯例，老板一定会指派一个小老板…...

编程日记 2023/9/30 6:54:39

pytest简明教程

1. 简介 pytest是一款基于Python的测试框架。与Python自带的unittest相比，pytes语法更加简洁，断言更加强大，并且在自动测试以及插件生态上比unittest都要更加强大。 1.1. 安装pytest pip install pytest1.2. pytest命名规则 pytest默认会…...

编程日记 2023/9/30 6:49:35

解决方案：解决https页面加载http资源报错

HTTPS页面加载HTTP资源会报错的原因是出于安全性考虑。 HTTPS（HyperText Transfer Protocol Secure）是一种通过使用SSL/TLS加密通信来保护数据传输的协议，它确保了客户端和服务器之间的安全连接。当HTTPS页面尝试加载非加密的HTTP资源时&a…...

编程日记 2023/9/30 6:45:31

嵌入式开源库之libmodbus学习笔记

socat 安装sudo apt-get install socat创建终端 socat -d -d pty,b115200 pty,b115200查看终端 ls /dev/pts/ minicom 安装 sudo apt-get install minicom链接虚拟终端 sudo minicom -D /dev/pts/3以十六进制显示 minicom -D /dev/pts/1 -H设置波特率 minicom -D /dev/pts/1…...

编程日记 2023/9/30 6:42:29

Spring MVC 中的数据验证技术

一、前言在Web开发中，数据验证是不可或缺的一部分。Spring MVC 框架提供了强大的数据验证支持，可以帮助我们轻松地对用户提交的数据进行验证。二、实现 Spring MVC 使用 JSR-303 验证规范（Hibernate Validator 是其参考实现）…...

编程日记 2023/9/30 6:38:25

windows 修改hosts映射，可以ping通，但是无法通过http url 路径访问，出现 500 Internal Privoxy Error

问题描述今天在学习nginx时，想在hosts配置一个nginx的域名映射，但是发现访问nginx服务的ip时可以访问通，在dos命令窗口ping配置的域名映射也可以ping通，但是一旦在浏览器通过http请求访问配置的hosts域名映射时却出现 500 Inter…...

编程日记 2023/9/30 6:37:24

如何将图片转为ico格式

这里主要是记录一个网站，如果你有更好的办法欢迎留言~ ico简介 ICO（Icon）是一种用于表示图标的文件格式，常用于Windows操作系统中。ICO格式的图片通常用于表示应用程序、文件夹、网站等的图标。 ICO文件可以包含多个图标&#x…...

编程日记 2023/9/30 6:35:22

ElasticSearch - 基于 JavaRestClient 操作索引库和文档

目录一、RestClient操作索引库 1.1、RestClient是什么？ 1.2、JavaRestClient 实现创建、删除索引库 1.2.1、前言 1.2.1、初始化 JavaRestClient 1.2.2、创建索引库 1.2.3、判断索引库是否存在 1.2.4、删除索引库 1.3、JavaRestClient 实现文档的 CRUD 1.3…...

编程日记 2023/9/30 6:31:18

【人脸质量评估】MagFace：一个既可以用作人脸识别，又可以用作人脸质量评估的方法

论文题目：《MagFace: A Universal Representation for Face Recognition and Quality Assessment》-CVPR2021 论文地址：https://arxiv.org/abs/2103.06627v4 代码地址：https://github.com/IrvingMeng/MagFace...

编程日记 2023/9/30 6:30:17

用node.js可以做网站吗/汤阴县seo快速排名有哪家好

step 1.选择GitHub作为博客服务器 *更详细的方法参考GitHub Pages官方文档注册GitHub 登陆https://github.com，创建属于自己的GitHub帐号（废话）。建立一个仓库 Repository name(仓库名)必须是 your_user_name.github.io 比如我的用户名…...

编程日记 2025/1/12 7:23:23