概要描述

Midgard 是以API形式为业务系统提供数据服务，支持快速将数据表生成API并完成API发布上线，对API进行统一管理，将已上线的API提供给第三方使用，涵盖API开发、发布、管理、调用、监控的全生命周期管理，支持黑白名单、流量控制、访问鉴权、调用方管控等安全管控策略，为客户提供全面的数据服务能力。

本篇文章讲述一下midgard基本的创建、使用调试，方便后续遇到问题，有助于问题定位和问题复现

详细说明

1. 首先确保对应的工作区内，已配置好可以用的数据源。
   

2. 在服务>API开发中创建api
   

   参数说明

   • api模式有向导模式和SQL模式：
     SQL模式即通过传统的编写sql语句来完成api；
     向导模式其实就是将SQL语句各个部分拆解了变成可填入模式。

   选择向导模式，数据库连接，数据库，数据库中的表后，对应的表结构会同步出来，如上图所示；

• 请求参数，类似于sql语句中的where条件，上图中的参数意思就是筛选目标表中patientid为00211的数据；

• 分页参数，主要是控制返回结果展示的设置：
  midgard_offset 即从查询结果第几位开始展示，0表示第一位；
  midgard_size 表示展示查询结果的总条数，类似于sql语句中的limit。

• 返回参数，顾名思义就是需要返回的字段，类似于SQL语句中的select的字段，该部分参数一定要配置，否则调用会不成功。

3. api的配置完成后，一定要先点击保存，才可以继续后续的调测

   

   API测试是发布之前的必须完成的步骤，midgard_offset为必选项，填入之后，点击测试即可测试调用
   返回结果如下
   

   对比源表数据
   

4. API测试完成后，可以发布
   

5. 发布完成后，需要admin用户或者其他对该工作区有审批权限的用户在流程中审批过后，才能供上线使用

   
   
   PS：这个审批的流程很容易被忽视掉，有客户修改了api之后，发现返回的数据并没有包含新的字段，修改api后也需要重新发布审批。

6. 发布并且审批完成后，即可以在API管理中上线API，供其他用户申请调用。
   
   上线前需要添加路由
   
   路由添加完成后测试成功即可上线
   

   测试过程更上篇中调试过程一样
   

   随后有api使用方角色的账户即可找到该api申请使用，下载查看api文档
   

7. 简单展示一下SQL模式
   

   注意：sql语句的话不需要已;结尾，否则会报错，因为发起查询的sql是拼接的
   

   Hope it helps~