跳到主要内容
版本：Latest(v3.0) 🔥

API Search · Design · Test · Share

API Search · Design · Test · Share 플로우​

1) Swagger 관리​

  • 경로: APIM 控制台 > 左侧菜单 > API 管理 > API 创建
  • 작업: 设置 Swagger 导入路径以注册 Swagger 源

2) API 배포​

  • 경로: APIM 控制台 > 左侧菜单 > API 管理 > 点击 API 名称 > API 详情 > API 部署
  • Swagger 미등록 시 선행 작업
    1. 在上述 Swagger 管理步骤中设置 Swagger 导入路径
    2. 返回 API 详情页面，点击 Swagger 가져오기 后 Swagger 저장하기 以保存
  • 배포: 在 API 详情页面进行部署。
  • 경로: APIM 控制台 > 左侧菜单 > API Search
  • 시나리오: 确认要开发的 API 端点是否存在，并决定修改/新开发
    • 搜索路径、方法、请求/响应体字段、摘要、描述等
    • 如果已经有所需的端点：利用现有 API，无需单独开发
    • 如果需要进行一些字段的添加等小改动：在执行现有端点测试后保存并共享历史，以将变更需求传达给开发者
    • 如果完全没有：设计/开发新的 API 端点
  • 주의사항
    • ⚠️ 为了进行 API Search，必须 APIM에 Swagger를 등록 관리。
    • ⚠️ API Search 的结果是基于 Swagger 정보 查询的。

4) API Docs Validation​

  • 경로: APIM 控制台 > 左侧菜单 > API 文档验证
  • 시나리오: 在新开发或现有 API 变更时，通过“API 格式验证”来验证文档标准的遵循
    1. 从本地/开发环境中提取程序生成的 Swagger JSON
    2. 上传/输入到 APIM 的“API 格式验证”中以执行验证
    3. 检查结果，如果发生标准不符合，则修改程序，最终通过验证
  • 주의사항
    • ⚠️ 在验证环境中通过验证后，进行生产环境的部署。
    • ⚠️ 这样，生产环境中的文档将以标准化的形式进行注册/发布/管理。