API文档的写法

参考 格式 ： API文档的写法

http://developer.baidu.com/wiki/index.php?title=%E5%B8%AE%E5%8A%A9%E6%96%87%E6%A1%A3%E9%A6%96%E9%A1%B5/%E7%99%BE%E5%BA%A6%E7%BF%BB%E8%AF%91/%E7%BF%BB%E8%AF%91API

百度翻译API

使用说明

   

接口描述翻译API描述

• 功能：将指定内容从指定源语言语种翻译为指定目标语言语种。
• URL

http://openapi.baidu.com/public/2.0/bmt/translate

• Header：

无特殊要求，默认即可

• Body

key
value
描述
from源语言语种：语言代码或auto仅支持特定的语言组合，下面会单独进行说明to目标语言语种：语言代码或auto仅支持特定的语言组合，下面会单独进行说明client_id开发者在百度连接平台上注册得到的授权API key 请阅读如何获取api keyq待翻译内容该字段必须为UTF-8编码，并且以GET方式调用API时，需要进行urlencode编码。

• 响应

UTF-8编码的PHP数组对应的标准JSON字符串。JSON的解析方式下面将单独进行说明。

• URL示例

GET请求方式： http://openapi.baidu.com/public/2.0/bmt/translate?client_id=YourApiKey&q=today&from=auto&to=auto

• Body示例

client_id=YourApiKey&q=today&from=auto&to=auto

• 响应示例

{"from":"en","to":"zh","trans_result":[{"src":"today","dst":"\u4eca\u5929"}]}

• 参数说明

        翻译API中包含的from和to字段目前仅限以下几种组合。百度翻译将不断增加对其它语言类型的翻译支持，以满足用户的多方面需求。

from字段
to字段
翻译方向
autoauto自动识别zhen中 -> 英zhjp中 -> 日enzh英 -> 中jpzh日 -> 中

说明

1.所有参数及其值均为小写字母

2.所有上表中未列明的方向组合均会被重置为from=auto&to=auto

3.自动识别的规则如下：

源语言识别为中文，则翻译方向为“中 -> 英”

源语言识别为英文，则翻译方向为“英 -> 中”

源语言识别为日文，则翻译方向为“日 -> 中”

响应数据格式说明成功输出接口

• 成功输出JSON格式：

{ “from”:”zh”, “to”:”en”, “trans_result”:[]}

• 说明：

字段
含义
约束
默认值
from实际采用的源语言（输入接口指定或者自动识别出的）必须无to实际采用的目标语言（输入接口指定或者自动识别出的）必须无trans_result结果体必须无

输出接口中的trans_result数组说明：
trans_result为一个数组，其中每一个{}就是一个段落，结构如下所示：

trans_result: [{},{},{}]

段落结果即为trans_result数组中的一项：

{“src”:””,“dst”:””}

段落结果说明：

字段
含义
约束
src原文必有dst译文必有错误输出接口

        只有发生错误时，返回的JSON中才包含error_code和error_msg字段，成功返回的结果中不会包含这两个字段。
        当API服务发生错误时，返回数据格式如下：

{ "error_code": "52001", "error_msg": "TIMEOUT", "from": "auto", "to": "auto", "query": "he's"}

说明：

字段
含义
约束
默认值
error_code错误码（52001，52002，52003）必须无error_msg错误信息：

TIMEOUT：超时（对应52001）
SYSTEM ERROR：翻译系统错误（对应52002）
UNAUTHORIZED USER：未授权的用户（对应52003）

必须无from调用API时的输入参数非必须仅用来帮助发现错误原因to调用API时的输入参数非必须仅用来帮助发现错误原因query调用API时的输入参数非必须仅用来帮助发现错误原因接口限制

        百度翻译API的使用频率默认限制为每个IP 1000次/小时。
        如果该频率不能满足您的使用需求，请联系：translate-service@baidu.com。

使用示例

• 待翻译内容（两个段落，每个段落的内容只有一个单词）：

today tomorrow

• URL示例（待翻译内容中的换行符’\n’经urlencode后变为%0A）：

http://openapi.baidu.com/public/2.0/bmt/translate?client_id=YourApiKey&q=today%0Atomorrow&from=auto&to=auto

• 返回结果：

{"from":"en","to":"zh","trans_result":[{"src":"today","dst":"\u4eca\u5929"},{"src":"tomorrow","dst":"\u660e\u5929"}]}

• 经json_decode后的形式：

{ "from": "en", "to": "zh", "trans_result": [ { "src": "today", "dst": "今天" }, { "src": "tomorrow", "dst": "明天" } ]}