文档中心 > API类目 > 小程序API

yunos.miniapp.doc.detail.get (获取文档详细信息)

获取api文档的详细内容

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
alipay_context String 必须 { "masterId": "1", "havanaNick": "1", "loginId": "1", "havanaId": "1"} 支付宝请求上下文
req DocDetailRequest 必须 系统自动生成
  • └ doc_id
  • Number
  • 必须
  • 80
  • api主键
  • └ type
  • String
  • 必须
  • api
  • 文档类型

响应参数

名称 类型 示例值 描述
result Result 接口返回model
  • result
  • Result
  • 接口返回model
  • details
  • Detail []
  • []
  • 接口返回model
  • └ code
  • String
  • baseInfo
  • code
  • └ name
  • String
  • 基础信息
  • 名称
  • └ html
  • String
  • html
  • └ type
  • String
  • base
  • 类型
  • childrens
  • Children []
  • 子数据
  • └ code
  • String
  • exampleCode
  • 代码块名字
  • └ name
  • String
  • CODE
  • 自定义,不能重复,切换tab时用的key
  • └ html
  • String
  • <div> </div>
  • 实例代码的html
  • └ title
  • String
  • my.getSystemInfo
  • 标题
  • └ success
  • Boolean
  • false
  • 是否成功
  • └ result_code
  • String
  • 200
  • 返回码
  • └ result_msg
  • String
  • 成功
  • 返回信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
YunosMiniappDocDetailGetRequest req = new YunosMiniappDocDetailGetRequest();
req.setAlipayContext("{ \"masterId\": \"1\", \"havanaNick\": \"1\", \"loginId\": \"1\", \"havanaId\": \"1\"}");
YunosMiniappDocDetailGetRequest.DocDetailRequest obj1 = new YunosMiniappDocDetailGetRequest.DocDetailRequest();
obj1.setDocId(80L);
obj1.setType("api");
req.setReq(obj1);
YunosMiniappDocDetailGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<yunos_miniapp_doc_detail_get_response>
    <result>
        <result>
            <details>
                <detail>
                    <code>baseInfo</code>
                    <name>基础信息</name>
                    <html></html>
                    <type>base</type>
                    <childrens>
                        <children>
                            <code>exampleCode</code>
                            <name>CODE</name>
                            <html>&lt;div&gt; &lt;/div&gt;</html>
                        </children>
                    </childrens>
                </detail>
            </details>
            <title>my.getSystemInfo</title>
        </result>
        <success>false</success>
        <result_code>200</result_code>
        <result_msg>成功</result_msg>
    </result>
</yunos_miniapp_doc_detail_get_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部