@ genapi/ 转换
Spec transform: Swagger 2 QQ OpenAPI 3, WordPress REST API → Swagger 2等,因此解析器工作采用统一格式.
安装
pnpm add @genapi/transform
API 密码
变形
swagger2ToSwagger3(source)
将 OpenAPI 3.x 规范为类似 Swagger 2 的形状(host, basePath, 方案, 定义来自组件. schemas) 。 用 Swagger 2( 基于工具) 进行突变并返回相同的对象 .
示例
const swagger2Like = swagger2ToSwagger3(openApi3Spec)
// swagger2Like.host, basePath, definitions, schemes set from servers/components
wpapiToSwagger2(source)
将 WordPress REST API 计划转换为 Swagger 2.0 格式.
示例
const swagger = wpapiToSwagger2({ routes: { '/wp/v2': { namespace: 'wp/v2', endpoints: [...] } } })
// Use with parser or pipeline as OpenAPI 2.0 input
buildParam(name, method, endpoint, detail)
从 WordPress 参数定义中构建一个单一的 OpenAPI 参数.
示例
buildParam('id', 'GET', '/posts/{id}', { type: 'integer' }) // { name: 'id', in: 'path', type: 'integer', ... }
convertEndpoint(endpoint)
自动失效
将 WordPress 风格的路径模式转换为 Swagger 路径格式.
示例
convertEndpoint('/wp/v2/posts/(?P<id>[\\d]+)') // '/wp/v2/posts/{id}'
default
变形
swagger2ToSwagger3(source)
将 OpenAPI 3.x 规范为类似 Swagger 2 的形状(host, basePath, 方案, 定义来自组件. schemas) 。 用 Swagger 2( 基于工具) 进行突变并返回相同的对象 .
示例
const swagger2Like = swagger2ToSwagger3(openApi3Spec)
// swagger2Like.host, basePath, definitions, schemes set from servers/components
wpapiToSwagger2(source)
将 WordPress REST API 计划转换为 Swagger 2.0 格式.
示例
const swagger = wpapiToSwagger2({ routes: { '/wp/v2': { namespace: 'wp/v2', endpoints: [...] } } })
// Use with parser or pipeline as OpenAPI 2.0 input
getParametersFromArgs(endpoint, args, method)
从 WordPress 端点参数构建 OpenAPI 参数.
示例
getParametersFromArgs('/posts/{id}', { id: { type: 'integer' } }, 'GET')
getParametersFromEndpoint(endpoint)
从 WordPress 风格的端点模式中提取路径参数.
示例
getParametersFromEndpoint('/posts/(?P<id>[\\d]+)') // [{ name: 'id', in: 'path', type: 'integer', required: true }]
许可证
自动更新 自动