从0到1的yapi接口文档部署记录

skills结合ai生成文档顺便记录下使用一开始我想的是就用ai生成文档还特意总结了skills方便后面使用总结如下--- name: Generate API Document For Controller description: 根据Controller生成详细的接口文档包含请求方式、入参解释、返回示例及返回字段详尽解释。 --- # Generate API Document For Controller 当你被要求为 Controller 或指定接口整理接口文档时请严格按照以下结构和要求输出 1. **接口基本信息** - 接口名称 - 接口路径 (Endpoint) - 请求方式 (GET/POST) - 请求体格式 (如 application/json, form-data, url parameters) 2. **入参说明 (请求参数)** - 以表格形式列出所有请求参数。 - 包含字段参数名、数据类型、是否必填。 - **必填要求**每个字段必须有**详细的含义解释**根据实体类或AO的注释/上下文推理。 - **核心要求**如果是 POST/PUT 等包含 Request Body 的请求必须单独提供一份具有代表性的 JSON **请求体示例**(Request Body Example)。 3. **返回数据说明 (响应参数)** - 提供一个完整的、具有代表性的 JSON 返回格式样例 (必须包含系统基础外层结构如 code, msg, data)。 - **核心要求强限制**以表格形式逐一解释返回的 JSON 尤其是 data 对象内部中的每一个字段含义和数据类型。不可省略字段解释 4. **输出格式** - 必须使用标准的 Markdown 语法多用表格和代码块。 - 全程使用中文遵循全局指令要求。但是这一套每次都需要花费老长时间去生成而且如果我有改动又要重新生成再粘贴到在线文档太麻烦了最终决定使用别的第三方。Yapi部署首先推荐使用docker-compose的方式安装方便追溯管理docker-compose.yml的内容如下ersion: 3 services: yapi-web: image: jayfong/yapi:latest container_name: yapi-web restart: unless-stopped ports: - 40001:3000 # 访问地址: http://localhost:40001 environment: - YAPI_ADMIN_ACCOUNTwutaochimeta.com # 管理员邮箱 - YAPI_ADMIN_PASSWORD111111 # 管理员密码请修改 - YAPI_CLOSE_REGISTERtrue # 关闭注册安全 - YAPI_DB_SERVERNAMEyapi-mongo # MongoDB 服务名 - YAPI_DB_PORT27017 - YAPI_DB_DATABASEyapi # 数据库名 - YAPI_MAIL_ENABLEfalse depends_on: - yapi-mongo volumes: - ./logs:/home/yapi/logs # 日志持久化 yapi-mongo: image: mongo:4.4 container_name: yapi-mongo restart: unless-stopped volumes: - ./data/db:/data/db # 数据持久化 command: [--bind_ip_all]然后执行docker compose up -d没有报错后用docker ps查看运行状态然后去阿里云开放端口号然后IP端口号浏览器进入使用账号和密码登录进去再新建个项目然后进入路径你的项目-设置-token配置-复制token接着去idea里面安装插件“easyYapi”装好后再在路径setting-other settings-Yapi 里面粘贴你的后台yapi的url如下截图回到代码界面找到个controller右击选择yapi-第一次会让你填入token就是刚刚叫你复制的token粘贴进去然后点确认这个controller里面的接口就生成上去了如图所示快捷键shiftalte