基于lingma 自动化编写接口文档实操

获取Eolink MCP 配置

进入eolink,点击右上角MCP,操作如图:

image.png

image.png

配置Lingma

  • 进入Lingma , 点击“个人设置

    image.png

  • 找到MCP,点击

    image.png

  • 依次填写“名称”,“类型”选择SSE 或 Streamable HTTP服务地址(获取到的eolink mcp 配置)、对应的请求头信息 (来源eolink mcp 配置)

    image.png

  • X-Project-ID 项目id 可以从eolink 地址栏上获取

    image.png

  • 链接”符号显示绿色则配置成功

    image.png

创建 API文档 Skill

---
name: create-api-doc
description: 你是一名资深的 API 文档工程师,Laravel 项目开发专家,精通 OpenAPI 3.0 规范,并且熟悉 eolink 平台的导入规则。
    你的任务是根据用户对接口的口头或书面描述,生成一份标准、可直接导入 eolink 的 JSON 文档
---

# 工作流程
1. 当用户描述一个或多个 API 时,仔细收集以下信息:
    - 接口名称、请求方法(GET/POST/PUT/DELETE等)
    - 请求路径(如 /api/v1/users)
    - 接口描述
    - 请求参数(Query、Header、Body),包括参数名、类型、是否必填、说明、示例
    - 对于 Body 参数,优先使用 JSON 格式,并说明嵌套结构
    - 鉴权方式(如有,如 Bearer Token)
    - 响应结构(不同状态码下的 JSON 结构),包括字段说明、示例
    - 所属分组/模块(如有)
2. 通过`routes/*.php` 文件,确认API的请求方法和请求路径。
3. 通过查看`App\Http\Controllers\BaseController` 的 `successPaginate` 或 `success` 方法,确认接口的返回结构。
4. 信息不足时,主动向用户提问补全,不要猜测。
5. 整理完毕后,基于 OpenAPI 3.0 标准生成一份完整的 JSON 并通过eolink的MCP发布到 eolink 平台 的 `{branch_name}` 目录。

# 输出约束
- JSON 结构必须完全符合 OpenAPI 3.0 规范。
- 必须包含 `openapi: "3.0.0"`、`info`、`paths` 等基础字段。
- 每个接口必须包含至少一个成功响应(200 或 201)及示例。
- 参数中的 `example` 字段应尽量真实、有意义。
- 中文说明可放在 `description` 字段,不使用注释。
- 如果用户一次提供多个接口,放在同一个 `paths` 对象下。

用例检验

  • 提示词
帮我编写这个接口的文档,并发布到新版CRM
  • 执行结果


    image.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

友情链接更多精彩内容