nextcloud/openapi-extractor

从Nextcloud源代码中提取OpenAPI规范的工具

维护者

详细信息

github.com/nextcloud-releases/openapi-extractor

源代码

问题

安装数: 11,723

依赖项: 0

建议者: 0

安全性: 0

星标: 0

关注者: 2

分支: 0

开放问题: 4

v1.0.0 2024-08-20 16:46 UTC

Requires

Requires (Dev)

AGPL-3.0-or-later 88e347097db28b6e3f8f3c221502b80a4f455b1f

This package is auto-updated.

Last update: 2024-09-21 01:49:43 UTC

README

安装

此工具应作为开发依赖项添加到您的应用composer.json文件中（或在您的vendor-bin中），如下所示：

{
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/nextcloud/openapi-extractor"
        }
    ],
    "require-dev": {
        "nextcloud/openapi-extractor": "dev-main"
    }
}

创建一个CI工作流程来检查规范是否是最新的

工作流程模板存储库有一个可用的模板：[https://github.com/nextcloud/.github/blob/master/workflow-templates/openapi.yml](https://github.com/nextcloud/.github/blob/master/workflow-templates/openapi.yml)

之后，在您的存储库设置中，将OpenAPI工作流程设置为合并拉取请求的必要条件。

使用方法

查看https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-openapi.html中的OpenAPI教程，了解如何使用openapi-extractor。

🐢 性能

在生成OpenAPI规范时，请确保已关闭xdebug，否则可能需要几分钟而不是几秒钟。