如果您希望将AI技术应用于API文档生成与代码注释自动化，可通过分析源代码结构、函数签名及上下文语义，自动生成符合规范的接口说明与注释内容。以下是实现该目标的具体方法：
一、使用OpenAPI Generator配合LLM增强注释
该方法基于已有的OpenAPI（Swagger）规范文件，利用大语言模型对缺失字段（如description、example、summary）进行语义补全，并反向生成带详细说明的YAML/JSON定义。核心在于将原始接口定义作为提示词输入，引导模型输出结构化补充内容。
1、准备一个基础openapi.yaml文件，其中paths部分仅包含路径和HTTP方法，无operationId、summary或responses描述。
2、将该文件内容拼接为系统提示词：“你是一个API文档工程师，请根据以下OpenAPI 3.0片段，为每个operation补充summary、description、requestBody.description、responses.200.description及各schema字段的example值。”
3、调用本地部署的Qwen2.5-7B-Instruct或Llama3-8B模型，传入上述提示词与原始YAML文本。
4、解析模型返回的纯YAML响应，校验格式合法性后覆盖原文件。
二、基于AST解析的Python函数级自动注释注入
该方法通过抽象语法树（AST）遍历Python源码，识别def节点及其参数列表、返回类型标注，再调用轻量级LLM为每个函数生成Google风格docstring，并直接写回源文件。不依赖运行时执行，适用于CI阶段集成。
1、使用ast.parse()加载目标.py文件，构建AST树。
2、继承ast.NodeVisitor类，重写visit_FunctionDef方法，在其中提取函数名、args、returns、decorator_list等信息。
3、构造提示词：“请为以下Python函数生成Google风格docstring，包含Args:、Returns:、Raises:三段，每段用冒号后空格缩进，不添加额外解释文字：def {name}({args}) -> {returns}:”
4、调用Ollama运行的Phi-3-mini模型，传入提示词，获取响应文本。
5、将生成的docstring插入到对应FunctionDef节点的body首项位置，使用ast.unparse()输出新代码并保存。
三、Java Spring Boot项目接口扫描+AI描述生成
该方法结合Springfox或SpringDoc的运行时端点扫描能力，获取所有@Operation标注缺失的接口元数据，再通过HTTP请求将接口路径、HTTP方法、参数类型发送至内部部署的ChatGLM3-6B服务，实时生成中文接口说明与示例请求体。
1、在Spring Boot应用中启用springdoc.api-docs.path=/v3/api-docs属性。
2、启动应用后访问http://localhost:8080/v3/api-docs，获取原始JSON响应。
3、编写Python脚本，遍历JSON中的paths对象，筛选出summary为空的operation条目。
。
