讲师中心 微信公众号
AI工具推荐 视频效率加速

如何编写自动化脚手架自动根据密封类元数据生成对应的外部API契约文档

阿雪同学_6849

阿雪同学_6849

发布时间:2026-06-28 11:19:19

|

378人浏览过

|

来源于php中文网

原创

直接根据密封类元数据生成OpenAPI契约文档,核心是通过KSP编译期反射递归解析其子类型拓扑,生成带discriminator的oneOf schema并注入主文档,配套运行时验证与CI一致性检查。

如何编写自动化脚手架自动根据密封类元数据生成对应的外部api契约文档

直接根据密封类(sealed class)的元数据生成外部 API 契约文档,核心在于:**把 Kotlin/Java 的类型结构(尤其是密封类的继承关系)映射为 OpenAPI 可描述的 schema,并自动化输出 JSON/YAML 格式文档**。不需要手写 Swagger 注解或重复维护契约,关键靠编译期反射 + 模板生成。

提取密封类的完整类型拓扑

密封类本质是一组有限、已知的子类型集合。要生成准确契约,必须递归解析其所有直接子类(包括对象、数据类、嵌套密封类),并识别:

  • 每个子类是否为 data class(决定是否展开为属性字段)
  • 是否存在嵌套密封类(需递归展开,避免循环引用)
  • 是否有 @Serializable 或自定义序列化注解(影响字段可见性与命名策略)
  • 字段是否带 @JvmField、@JsonProperty 等元数据(用于修正 OpenAPI 字段名与类型)

用 KSP 或 KAPT 生成 OpenAPI Schema 片段

推荐使用 Kotlin Symbol Processing (KSP),它比 KAPT 更快、更安全,且原生支持密封类结构分析:

  • 遍历 KSClassDeclaration,过滤出 isSealed 且 isData 为 false 的类(即密封类本身)
  • 调用 getSealedSubclasses() 获取全部子类型,再对每个子类生成独立的 schema 对象
  • 为整个密封类生成一个联合 schema(如 OpenAPI 3.1 的 oneOf),每个子项对应一个 $ref 到其子类 schema
  • 生成时自动添加 discriminator(例如基于 type 字段),便于客户端反序列化

集成到构建流程并导出标准 OpenAPI 文档

生成的 schema 片段需合并进主 OpenAPI 文档(如 openapi.yaml)。可采用两种方式:

  • 增量注入:KSP 生成一个 sealed-schemas.json,构建后由 Gradle 任务读取并 patch 到主文档的 components.schemas 下
  • 全量生成:用 Kotlin 脚本(如 generate-openapi.kts)在 processResources 阶段执行,扫描所有标注了 @ApiContract 的密封类,输出完整 YAML
  • 确保生成内容符合 OpenAPI 规范:字段类型映射正确(Long → integer,LocalDateTime → string + format: date-time),枚举值展开,nullable 字段标记 "nullable": true

配套支持:运行时验证与文档一致性检查

光有文档不够,还要防止代码与契约脱节:

  • 在单元测试中加载生成的 OpenAPI 文档,用 swagger-parser 校验语法,并断言密封类所有子类都被包含在 oneOf 中
  • 结合 springdoc-openapi 或 microprofile-openapi,让运行时 API 文档自动包含这些 schema(需注册自定义 SchemaCustomizer)
  • CI 中加入 diff 检查:每次 PR 提交后比对新旧 OpenAPI 文件,若密封类结构变更但文档未更新,则失败

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

9817

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

6962

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

6152

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1064

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

888

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

1296

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2569

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

19911

2023.08.03

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

80

2026.09.30

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 9.3万人学习

apipost极速入门
apipost极速入门

共6课时 | 0.6万人学习

Runway官方API文档
Runway官方API文档

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn