Swagger Doc Creator
概述
该技能在 API 开发领域内为 swagger doc creator 相关任务提供自动化辅助。
何时使用
当出现以下情况时,该技能会自动激活:
在请求中提及 “swagger doc creator”
询问 swagger doc creator 的模式或最佳实践
需要 API 开发相关技能帮助,涵盖 REST、GraphQL、OpenAPI、认证和 API 设计模式。
工作方式
为 swagger doc creator 提供分步指导
遵循行业最佳实践与模式
生成可投产的代码和配置
依据通用标准校验输出
示例
示例:基础用法 请求:“Help me with swagger doc creator” 结果:提供分步指导并生成相应配置
前提条件
已配置相关开发环境
可访问必要工具和服务
对 API 开发概念有基本了解
输出
生成的配置和代码
最佳实践建议
校验结果
错误处理
错误 / 原因 / 解决方案
配置无效 / 缺少必填字段 / 查阅文档以确认所需参数
未找到工具 / 未安装依赖 / 按前提条件安装所需工具
权限被拒绝 / 访问权限不足 / 核实凭据和权限
资源
相关工具的官方文档
最佳实践指南
社区示例与教程
相关技能
属于 API Development 技能类别。 标签:api、rest、graphql、openapi、swagger