接口定义
提示
请先注册RepChain账号,并登录到RepChain-Dashboard管理控制台页面。
接口协同所有操作均以此为前提。
注意
接口定义语言使用OpenAPI,详情可点击此处查看。
一、描述
- 接口定义,用规范好的接口定义语言进行接口描述,并展示在界面中,提供其他调用及服务方进行实现。
- 当前版本接口定义语言为OpenAPI,具体描述可点击此处查看。
- 如果项目中使用了Swagger-UI,那么可以通过Swagger-UI的接口获取接口描述的JSON。将JSON复制到接口定义中即可。
- 接口定义可在服务定义创建时编写,也可以在服务定义创建好后通过编辑进行编写。
- 接口定义默认给出JSON示例,编写可根据示例修改或直接替换成已经写好的JSON。
- 如果请求为异步操作时,最好将应答方接口定义一并编写。规范调用方所需要实现的应答接口。