README

此Drupal模块为文件和链接类型的字段提供字段格式化器，如果文件是有效的Swagger文件，则使用Swagger UI渲染引用的文件。支持的文件类型是JSON（.json）和/或YAML（.yml或.yaml）。

此模块使用Swagger UI JavaScript库。

要全面了解模块，请访问drupal.org上的项目页面。

要提交错误报告和功能建议，或跟踪更改，请访问模块的GitHub仓库。

要求

请注意，当前最低支持的Swagger UI库版本是3.32.2，因为在本发布时，这是包含安全修复的最新版本。

模块安装

按照通常安装贡献Drupal模块的方式安装Swagger UI Field Formatter模块。有关更多信息，请访问官方安装模块文档。

Swagger UI库安装

手动安装

下载适当的Swagger UI库版本，解压缩归档并重命名文件夹为"swagger-ui"。将重命名的文件夹放入[DRUPAL ROOT]/libraries目录中，其路径为[DRUPAL ROOT]/libraries/swagger-ui。

通过Composer安装

如果您想使用Composer安装Swagger UI库，您可能使用了Drupal 8项目的项目模板来设置您的项目。要安装JavaScript库，建议使用asset-packagist仓库。因此，您需要在"repositories"部分将以下内容添加到您的composer.json文件中

{
    "type": "composer",
    "url": "https://asset-packagist.org"
}

还需要将"extra/installer-paths"部分扩展为

"web/libraries/{$name}": [
    "type:drupal-library",
    "type:bower-asset",
    "type:npm-asset"
],
"web/libraries/swagger-ui": ["bower-asset/swagger-ui"],

并在"extra/installer-paths"旁边添加一个新"installer-types"部分

"installer-types": ["bower-asset", "npm-asset"],

在此之后，您可以使用以下命令安装库

composer require oomphinc/composer-installers-extender bower-asset/swagger-ui

库将下载到[DRUPAL ROOT]/libraries目录中。

配置

文件字段

在Drupal管理UI中导航到"结构" > "内容类型" > 类型 > "管理字段"，其中类型是要添加新字段的类型，例如基本页面。
点击"添加字段"按钮以添加新字段。
将字段类型设置为"文件"并输入标签名称。
点击"保存并继续"。
在"编辑"选项卡中，在"允许的文件扩展名"字段中输入以下内容：yaml,yml,json
点击"保存设置"。
点击"管理显示"选项卡。
对于新字段，在"格式"下拉菜单中选择"Swagger UI"，并可选地配置格式化器设置。
点击"保存"。
添加一个新的类型类型内容并上传一个有效的Swagger文件。

链接字段

在Drupal管理UI中导航到"结构" > "内容类型" > 类型 > "管理字段"，其中类型是要添加新字段的类型，例如基本页面。
点击"添加字段"按钮以添加新字段。
将字段类型设置为"链接"并输入标签名称。
点击"保存并继续"。
在"编辑"选项卡中按需管理字段设置。
点击"保存设置"。
点击"管理显示"选项卡。
对于新字段，在"格式"下拉菜单中选择"Swagger UI"，并可选地配置格式化器设置。
点击"保存"。
添加新的类型内容并提供有效的Swagger文件路径。

在查看内容页面时，上传的或引用的Swagger文件将由Swagger UI进行渲染。

故障排除

如果Swagger文件的内容无法正确渲染，请尝试通过导航到Drupal管理界面中的“配置”>“开发”>“性能”来清除缓存，并点击“清除所有缓存”按钮。

如果清除缓存没有帮助，也值得检查“报告”>“状态报告”页面上的Swagger UI库相关条目，以查看库是否被正确识别，或者是否存在任何问题。

testudio / swagger_ui_formatter

维护者

详细信息