README

运行命令

composer require fgsl/swagger-docs

获取 Composer: https://getcomposer.org.cn/download/

如何使用

见以下示例

vendor/bin/fsd

默认值： 源目录： src/ 目标目录： public/。

对于不同的源目录，请将目录名作为第一个参数传递。

对于不同的目标目录，请将目录名作为第二个参数传递。

所以

vendor/bin/fsd [sourceDirectory] [targetDirectory]

[sourceDirectory] 和 [targetDirectory] 是相对于应用程序根目录的。

构建

vendor/bin/phing

依赖

此项目依赖于 swagger-php。

注解

关于注解的更多信息，请参阅 swagger-php 注解。

但也许你可以通过示例学到更多。

API 页面模型

以下页面显示了由该组件生成的文档。您只需用应用程序的根 URL 替换 [WEB ROOT ROUTE]。

例如，对于 Laminas PHP 应用程序，[WEB ROOT ROUTE] 是 <?=$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

维护者

详细信息

README

如何使用

构建

依赖

注解

API 页面模型