包简介

Swagger Documentation Generator

README 文档

README

Run command:

composer require fgsl/swagger-docs

For getting Composer: https://getcomposer.org/download/

How to use

See sample below:

vendor/bin/fsd

Defaults: source directory: src/ target directory: public/.

For an alternative source directory, pass the directory name as first argument.

For an alternative target directory, pass the directory name as second argument.

So:

vendor/bin/fsd [sourceDirectory] [targetDirectory]

[sourceDirectory] and [targetDirectory] are relative to root directory of application.

Build

vendor/bin/phing

Dependency

This project depends on swagger-php.

Attributes

Use attributes for generating SWagger documentation.

Read about attributes in swagger-php attributes topic.

But maybe you can learn better by examples.

Model for API page

The following page shows the documentation generated by this component. You only need to replace [WEB ROOT ROUTE] by the root URL of your application.

For example, for a Laminas/Mezzio PHP application, [WEB ROOT ROUTE] is <?=$this->url('home')?>.

<!-- HTML for static distribution bundle build -->
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8">
    <title>Swagger UI</title>
    <link rel="stylesheet" type="text/css" href="[WEB ROOT ROUTE]swagger-ui.css" >
    <link rel="icon" type="image/png" href="[WEB ROOT ROUTE]favicon-32x32.png" sizes="32x32" />
    <link rel="icon" type="image/png" href="[WEB ROOT ROUTE]favicon-16x16.png" sizes="16x16" />
    <style>
      html
      {
        box-sizing: border-box;
        overflow: -moz-scrollbars-vertical;
        overflow-y: scroll;
      }

      *,
      *:before,
      *:after
      {
        box-sizing: inherit;
      }

      body
      {
        margin:0;
        background: #fafafa;
      }
    </style>
  </head>

  <body>
    <div id="swagger-ui"></div>
    <script src="[WEB ROOT ROUTE]swagger-ui-bundle.js"> </script>
    <script src="[WEB ROOT ROUTE]swagger-ui-standalone-preset.js"> </script>
    <script src="[WEB ROOT ROUTE]spec.js"> </script>
    <script>
    window.onload = function() {
      // Begin Swagger UI call region
      const ui = SwaggerUIBundle({
        //url: "https://petstore.swagger.io/v2/swagger.json",
        spec : spec,
        dom_id: '#swagger-ui',
        deepLinking: true,
        presets: [
          SwaggerUIBundle.presets.apis,
          SwaggerUIStandalonePreset
        ],
        plugins: [
          SwaggerUIBundle.plugins.DownloadUrl
        ],
        layout: "StandaloneLayout"
      })
      // End Swagger UI call region

      window.ui = ui
    }
  </script>
  </body>
</html>

fgsl/swagger-docs 适用场景与选型建议

fgsl/swagger-docs 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 29 次下载、GitHub Stars 达 0，最近一次更新时间为 2025 年 09 月 19 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「generator」「documentation」「swagger」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 fgsl/swagger-docs 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 fgsl/swagger-docs 我们能提供哪些服务？

定制开发 / 二次开发

基于 fgsl/swagger-docs 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发