ThinkPHP6 swagger文档

最新推荐文章于 2023-12-08 11:35:52 发布

Sword-Holy

最新推荐文章于 2023-12-08 11:35:52 发布

阅读量539

点赞数

文章标签： restful java json

本文链接：https://blog.youkuaiyun.com/phpBin/article/details/121993051

版权

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

复制swagger-ui目录下dist文件到thinkphp项目public目录下

composer require zircote/swagger-php

composer require uniadmin/uniadmin-apidoc dev-master

修改dist下inedx.html文件的url

swagger文档：http://192.168.88.12:8081/dist/index.html

uniadmin-apidoc：http://192.168.88.12:8081/doc

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

Sword-Holy

关注关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

thinkphp6 Swagger|OpenAPI

OnTheway

08-23

1928

起：报错等 Required @OA\Info() not found Required @OA\PathItem() not found 原因：扫描目录中的类方法未进行对应格式的注释。新手使用，看相关的资料不多记录一下安装在thinkphp对应根目录 composer require zircote/swagger-php 文档生成通过访问对应控制器方法来生成或使用命令行生成 public function doc(){ $openapi = \O

thinkphp 集成swagger-php

echo_hello_world的博客

10-17

1038

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

参与评论您还未登录，请先登录后发表或查看评论

swagger在thinkphp6的使用方式

U.R.M.L

12-06

3137

以下以thinkphp6框架及dev.think.com项目域名进行示范：下载swagger-ui git clone https://github.com/webjars/swagger-ui.git 复制swagger-ui目录下dist文件到php项目根目录如：thinkphp6的public目录下打开php项目安装swagger-php拓展 composer require z...

Think PHP6+Swagger3

dmedaa的博客

06-08

1479

swagger是一个解决接口规范化、标准化、文档化的一个组件，既可以直接自动生成resutful接口文档又能进行功能测试的一个web服务。本文是think PHP6结合swagger3的一个记录过程。

swagger的php配置,thinkphp6+swagger-php配置管理接口文档

weixin_32243309的博客

03-25

705

swagger2 升级到了3，并改名为OpenAPI Spec，所有部分注解有一些变化，这里以thinkphp6+swagger-php3.0来配置1、前端部分git或dowload一份swagger-ui到能够访问到服务目录中，如我这里nginx配置指向到thinkphp6根目录public中,所以download一份swagger-ui到该根目录中，swagger-ui下载地址https://...

关于THINKPHP5 集成 Swagger (一次成功)

奋斗

01-10

2501

后端安装 1.找到你项目中ThinkPHP文件里的composer.json文件，在require里面添加 “zircote/swagger-php”: “*” 进行安装，如下： 2.查看thinkphp下vendor有一个zircote文件夹表面安装成功前端安装 1.下载swagger-ui.git git clone https://github.com/swagger-api/swa...

跟我学，一步步教你搭建文档自动化工具Swagger-PHP（ThinkPHP5环境）

时光清浅处，一步一安然

11-13

2800

1. 安装Composer 确认Composer是否已安装，cmd窗口输入命令： composer -V 如果能看到版本号信息，说明Composer已经安装，如图：否则请自行下载安装，下载地址： https://getcomposer.org/download/ 2. 安装swagger-php cmd窗口中，切换到TP5项目的根目录，输入命令： composer require zircote/swagger-php 安装成功后，vendor目录下...

0到1实现thinkphp6+swagger-php3.0配置管理接口文档

qq_22146915的博客

04-09

2359

本文介绍运用thinkphp6开发api接口如何接入swagger，并且把接口请求常用的语法做了简单的记录

tp6 app接口集成Swagger生成接口文档

u013519290的博客

04-26

810

开发环境是win10系统 1、安装swagger-php扩展 composer require zircote/swagger-php 2、

TP5集成swagger

12-19

thinkphp5集成swagger的文档，本人已亲自踩坑，按步骤来绝对没问题，内含作者联系方式

Swagger3/thinkphp6教程

qq_38757174的博客

04-30

1394

Swagger-PHP v3.x/thinkphp6教程网上搜了很多关于swagger-PHP的教程,要么就是写的很乱,我完全看不懂,要么就是版本太旧,所以决定自己摸索一遍,顺便写一篇教程,日后好记!!! 准备工作 (要有一点PHP基础,起码要能搭建PHP环境,让PHP程序跑起来): 安装Composer,windows下载,如果遇到任何问题或者想更深入地学习 Composer，请参考Composer 文档（英文文档，中文文档）安装thinkphp6,确保能正常运行(不懂得可看 ThinkPHP6.0

Thinkphp下搭建Swagger UI

萌萌的博客

10-28

4856

作为后台开发人员，总是避免不了要给APP写API接口文档，之前都是用HTML5和CSS3+Jqury去写动态页面，但是每次修改的时候很麻烦，而且有可能改完代码忘记修改文档，所以就在网上找了些资料，发现Swagger ui这个框架大家都是比较推荐的，现在就记录一下环境的搭建。 Swagger ui 也是基于html+javascript实现的，而且可以实现在线测试的功能，方便开发人员和测试人员进行测

Swagger PHP Thinkphp 接口文档

made4971的博客

12-08

1200

在thinkphp中使用swagger生成接口文档

使用ThinkPHP3.2实现Swagger API文档自动生成

理论都是虚的，代码才是王道。

12-02

263

在现代Web开发中，API文档的自动生成已经成为了一个常见的需求。这不仅可以帮助开发者更好地理解和使用API，还可以提高开发效率。本文将介绍如何使用ThinkPHP3.2实现Swagger API文档的自动生成。

swagger

itmaomao123456的博客

01-13

264

1.打开tp下的composer.json修改 "require":{ "PHP": ">=5.4.0", "topthink/framework":"^5.0" }, //在require后增加zircote/swagger-php "require":{ "PHP": ">=5.4.0", "topthink/framework":"^5.0", ...

swagger生成接口文档php项目,thinkphp结合swagger自动生成接口文档

weixin_34369597的博客

04-10

387

1、swagger安装第一步：安装swagger-ui前端去这里下载https://github.com/swagger-api/swagger-ui下载完成之后，将文件夹放到你的网站根目录上面，例如我是放在我wamp下面的www目录。接着找到dist目录, 打开index.html把其中的那一串url改成自己的比如http://localhost/tp/public/swagger.json注...

thinkphp结合swagger自动生成接口文档，附案例使用

dk2319193的博客

09-03

1375

1、swagger安装第一步：安装swagger-ui前端去这里下载https://github.com/swagger-api/swagger-ui 下载完成之后，将文件夹放到你的网站根目录上面，例如我是放在我wamp下面的www目录。接着找到dist目录, 打开index.html把其中的那一串url改成自己的比如http://localhost/tp/public/...

thinkphp swagger

最新发布

02-07

### ThinkPHP 集成 Swagger 教程 #### 一、安装依赖包为了在ThinkPHP中集成Swagger，可以借助`thinkphp-apidoc`这个扩展来实现API文档的自动生成。该工具能够解析注释并生成相应的API文档。对于ThinkPHP项目的开发者来说，可以通过Composer安装此库[^2]: ```bash composer require hg/thinkphp-apidoc ``` #### 二、配置路由与控制器完成上述操作之后，在应用内创建一个新的控制器用于处理API请求，并按照官方指南编写对应的接口方法以及必要的注解说明参数含义等内容。例如： ```php <?php namespace app\controller; use think\Controller; /** * @SWG\Post( * path="/example", * tags={"Example"}, * summary="This is an example API.", * operationId="postExample", * consumes={"application/json"}, * produces={"application/json"}, * @SWG\Parameter( * name="body", * in="body", * required=true, * description="The data to be sent as the body of the request", * type="string" * ), * @SWG\Response(response=200,description="successful operation"), * ) */ class Example extends Controller { public function index(){ // Your code here... } } ``` 这段代码展示了如何利用`@SWG`标签定义一个POST类型的HTTP请求路径及其相关信息[^3]。 #### 三、部署Swagger UI 为了让用户更方便地浏览和测试这些API接口，还需要引入Swagger UI组件。这一步骤涉及下载swagger-ui资源并将它们放置于合适的位置以便浏览器可以直接加载显示出来。具体做法如下所示[^4]: 1. 下载最新版本的Swagger UI源码； 2. 将其解压后的文件夹复制到网站根目录下的`public`子目录里； 3. 修改位于其中的`index.html`文件内的JavaScript初始化脚本部分，设置好指向本地生成好的JSON格式描述文件的具体URL地址；以上就是关于怎样把Swagger融入到基于ThinkPHP框架构建的应用程序当中去的大致流程介绍。值得注意的是，实际开发过程中可能还会遇到其他细节上的调整需求，因此建议参考相关资料深入学习掌握更多技巧。