OpenSearch描述文档XML怎么写

OpenSearch 描述文档是声明 Web 搜索服务的 XML 文件，需以 UTF-8 编码，根元素为 <OpenSearchDescription>，含 ShortName、Description、Url（含 {searchTerms} 占位符）等必需字段，并通过 HTML <link> 标签声明以便浏览器发现。

基本结构与必需字段

XML 必须以 UTF-8 编码，根元素为 <OpenSearchDescription>，并声明命名空间：
xmlns="http://a9.com/-/spec/opensearch/1.1/"
必需子元素包括：

• ShortName：≤16 字符的简短名称（如 “MySite Search”）
• Description：≤1024 字符的说明（如 “Search articles on MySite”）
• Url：含 type 和 template 属性的搜索端点，rel="search" 表示默认搜索；支持 {searchTerms} 占位符

Url 元素写法与参数支持

<Url> 是关键部分，常见写法如下：

• GET 请求（最常用）：
  <Url type="text/html" method="get" template="https://example.com/search?q={searchTerms}" />
• 支持多个参数（用 & 连接）：
  template="https://example.com/s?k={searchTerms}&lang=zh&format=json"
• 支持可选占位符：{searchTerms}（必填）、{language}、{inputEncoding}、{outputEncoding}
• 若需 POST 请求，设 method="post"，但多数浏览器仅支持 GET

可选但推荐的增强字段

提升兼容性与体验，建议补充：

Amazon Nova

亚马逊云科技（AWS）推出的一系列生成式AI基础模型

下载

• Image：16×16 或 64×64 PNG 或 ICO 图标（用于地址栏显示）
  <Image height="16" width="16" type="image/x-icon">https://example.com/favicon.ico</Image>
• InputEncoding 和 OutputEncoding：明确声明编码（通常为 UTF-8）
• Tags：空格分隔的关键词（如 <Tags>search site example</Tags>）
• Developer、Contact、Attribution：归属信息（非强制）

完整示例（可直接保存为 opensearch.xml）

<?xml version="1.0" encoding="UTF-8"?>
<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
  <ShortName>MyBlog Search</ShortName>
  <Description>Search posts and tutorials on MyBlog</Description>
  <Tags>blog tutorial dev</Tags>
  <Contact>admin@myblog.com</Contact>
  <Url type="text/html" method="get"
       template="https://myblog.com/search?q={searchTerms}&src=os"/>
  <InputEncoding>UTF-8</InputEncoding>
  <OutputEncoding>UTF-8</OutputEncoding>
  <Image height="16" width="16" type="image/x-icon">
    https://myblog.com/favicon.ico
  </Image>
</OpenSearchDescription>