使用说明定义

提示

请先注册RepChain账号，并登录到RepChain-Dashboard管理控制台页面。

接口协同所有操作均以此为前提。

注意

使用说明为编写当前服务的说明，使用说明为Markdown格式。

一、 描述

使用说明使用Markdown格式，在接口定义时，可将具体一些描述内容写入其中。

如：

1. 服务有一些特殊的接口调用方式。
2. 服务如何鉴权，鉴权流程等信息。
3. 定义方联系方式等。
4. OpenAPI接口定义语言无法描述的一些信息。

使用说明可在新建服务定义时填写，也可以在服务定义基本信息保存好以后，点击编辑进行填写。

使用说明中包含一些Markdown语法示例，可删除后编写服务定义相关说明内容。

注意

如果服务定义为 异步 返回数据，则推荐同时也填写应答方使用说明，两者使用方法一致。

二、使用示例

左侧为输入编辑器，右侧为实时预览展示内容。