0

0

如何通过 Composer Scripts 自动生成文档或 API 客户端?

裘德小鎮的故事

裘德小鎮的故事

发布时间:2025-12-18 16:29:02

|

755人浏览过

|

来源于php中文网

原创

Composer Scripts 可调用 phpDocumentor、OpenAPI Generator 等工具自动生成文档和 API 客户端;只需在 composer.json 的 scripts 中配置对应命令,如 "docs:generate" 和 "client:generate",并确保工具已安装即可实现一键生成。

如何通过 composer scripts 自动生成文档或 api 客户端?

Composer Scripts 本身不直接生成文档或 API 客户端,但它可以作为自动化入口,调用专门的工具(如 Swagger CLI、OpenAPI Generator、phpDocumentor 等)来完成这类任务。关键在于把生成逻辑封装成可执行命令,并在 composer.jsonscripts 段中注册。

配置 Composer Script 调用文档生成工具

比如用 phpDocumentor 生成 PHP 代码文档:

  • 先安装: composer require --dev phpdocumentor/phpdocumentor
  • composer.json 中添加脚本:
    "scripts": {
      "docs:generate": "phpdocumentor -d src -t docs/api"
    }
  • 运行:composer docs:generate,就会在 docs/api 下生成 HTML 文档

用 OpenAPI Generator 自动生成 API 客户端

如果你有 OpenAPI/Swagger 规范文件(如 openapi.yaml),可以用 OpenAPI Generator 生成 PHP 客户端:

360智图
360智图

AI驱动的图片版权查询平台

下载
  • 推荐通过 Composer 全局或本地安装其 CLI 工具(如用 composer global require openapitools/openapi-generator-cli
  • composer.json 中定义脚本:
    "scripts": {
      "client:generate": "openapi-generator generate -i openapi.yaml -g php -o generated-client --additional-properties=packageName=MyApiClient"
    }
  • 运行 composer client:generate,即可生成可直接 require 的 PHP SDK

组合脚本实现一键流程

可以把多个步骤串起来,比如先生成 OpenAPI 文件,再生成客户端和文档:

  • zircote/swagger-php 从注解生成 openapi.json
  • 再用该文件驱动文档和客户端生成
  • 脚本示例:
    "scripts": {
      "api:refresh": [
        "php vendor/bin/openapi --output openapi.json src/",
        "composer client:generate",
        "composer docs:generate"
      ]
    }

基本上就这些。核心是选对工具、写对命令、配好路径。不需要改 Composer 源码,也不需要写 PHP 脚本——只要命令行能跑,就能塞进 scripts 里。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

154

2023.12.25

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

419

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

535

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

311

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

77

2025.09.10

require的用法
require的用法

require的用法有引入模块、导入类或方法、执行特定任务。想了解更多require的相关内容,可以阅读本专题下面的文章。

466

2023.11.27

PHP 命令行脚本与自动化任务开发
PHP 命令行脚本与自动化任务开发

本专题系统讲解 PHP 在命令行环境(CLI)下的开发与应用,内容涵盖 PHP CLI 基础、参数解析、文件与目录操作、日志输出、异常处理,以及与 Linux 定时任务(Cron)的结合使用。通过实战示例,帮助开发者掌握使用 PHP 构建 自动化脚本、批处理工具与后台任务程序 的能力。

41

2025.12.13

Golang 网络安全与加密实战
Golang 网络安全与加密实战

本专题系统讲解 Golang 在网络安全与加密技术中的应用,包括对称加密与非对称加密(AES、RSA)、哈希与数字签名、JWT身份认证、SSL/TLS 安全通信、常见网络攻击防范(如SQL注入、XSS、CSRF)及其防护措施。通过实战案例,帮助学习者掌握 如何使用 Go 语言保障网络通信的安全性,保护用户数据与隐私。

2

2026.01.29

俄罗斯Yandex引擎入口
俄罗斯Yandex引擎入口

2026年俄罗斯Yandex搜索引擎最新入口汇总,涵盖免登录、多语言支持、无广告视频播放及本地化服务等核心功能。阅读专题下面的文章了解更多详细内容。

446

2026.01.28

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 10.1万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 11.2万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号