# Windfonts 官方 API 文档

## 基本概念

Windfonts 文风字体服务是一项可以像请求前端资源库的在线字体（web fonts）服务。

[](#%E5%AD%97%E4%BD%93%E5%88%97%E8%A1%A8)字体列表

当前接口可通过参数分页查询文风字体库的字体列表

### [](#bkmrk-%E8%AF%B7%E6%B1%82%E5%9C%B0%E5%9D%80)请求地址

```
POST   https://app.windfonts.com/api/fonts/list


```

### [](#bkmrk-%E6%9F%A5%E8%AF%A2%E6%9D%A1%E4%BB%B6)查询条件

接口支持查询参数如下

<figure class="wp-block-table" id="bkmrk-body%E5%B1%9E%E6%80%A7%E7%B1%BB%E5%9E%8B%E5%B1%9E%E6%80%A7%E6%8F%8F%E8%BF%B0%E6%98%AF%E5%90%A6%E5%BF%85%E4%BC%A0page"><table class="has-fixed-layout"><thead><tr><th>Body</th><th>属性类型</th><th>属性描述</th><th>是否必传</th></tr></thead><tbody><tr><td>pageData</td><td>object<code>&#123;page&#58;number&#44;size&#58;number&#125;</code></td><td>分页信息</td><td>是</td></tr><tr><td>tags</td><td>string</td><td>标签</td><td>否</td></tr><tr><td>category</td><td>string</td><td>分类</td><td>否</td></tr><tr><td>keyword</td><td>string</td><td>关键词</td><td>否</td></tr></tbody></table>

</figure>

> **提示:** 你可以一次传多个参数.

#### [](#bkmrk-%E6%9F%A5%E8%AF%A2%E5%8F%82%E6%95%B0%E7%A4%BA%E4%BE%8B)查询参数示例

```
{
  "pageData": {
    "page": 1,
    "size": 5
  }
}

```

### [](#bkmrk-%E5%93%8D%E5%BA%94%E6%95%B0%E6%8D%AE)响应数据

该接口返回的是一个对象结构

#### [](#bkmrk-%E6%95%B0%E6%8D%AE%E8%BF%94%E5%9B%9E%E7%BB%93%E6%9E%84)数据返回结构

<figure class="wp-block-table" id="bkmrk-%E5%B1%9E%E6%80%A7%E5%90%8D%E6%95%B0%E6%8D%AE%E7%B1%BB%E5%9E%8B%E6%8F%8F%E8%BF%B0codestring%E5%93%8D"><table class="has-fixed-layout"><thead><tr><th>属性名</th><th>数据类型</th><th>描述</th></tr></thead><tbody><tr><td>code</td><td>string</td><td>响应状态码</td></tr><tr><td>message</td><td>number</td><td>响应信息状态信息</td></tr><tr><td>data</td><td>object</td><td>数据主体，数组对象</td></tr></tbody></table>

</figure>#### [](#bkmrk-data)data

<figure class="wp-block-table" id="bkmrk-%E5%B1%9E%E6%80%A7%E5%90%8D%E6%95%B0%E6%8D%AE%E7%B1%BB%E5%9E%8B%E6%8F%8F%E8%BF%B0datalistarr"><table class="has-fixed-layout"><thead><tr><th>属性名</th><th>数据类型</th><th>描述</th></tr></thead><tbody><tr><td>dataList</td><td>array</td><td>字体列表信息</td></tr><tr><td>page</td><td>number</td><td>分页，当前第几页</td></tr><tr><td>pageTotal</td><td>number</td><td>总页数</td></tr><tr><td>total</td><td>number</td><td>字体总数</td></tr></tbody></table>

</figure>#### [](#bkmrk-datalist)dataList

<figure class="wp-block-table" id="bkmrk-%E5%B1%9E%E6%80%A7%E5%90%8D%E6%95%B0%E6%8D%AE%E7%B1%BB%E5%9E%8B%E6%8F%8F%E8%BF%B0idstring%E5%94%AF%E4%B8%80i"><table class="has-fixed-layout"><thead><tr><th>属性名</th><th>数据类型</th><th>描述</th></tr></thead><tbody><tr><td>id</td><td>string</td><td>唯一id</td></tr><tr><td>name</td><td>string</td><td>字体名称</td></tr><tr><td>fontFamily</td><td>string</td><td>字体使用名称 – 可用于设置css属性font-family</td></tr><tr><td>fontSubfamily</td><td>string</td><td>子字体名称 – 可用于设置css属性font-weight</td></tr><tr><td>version</td><td>string</td><td>版本号</td></tr><tr><td>copyright</td><td>string</td><td>版权信息</td></tr><tr><td>description</td><td>string</td><td>描述信息</td></tr><tr><td>designer</td><td>string</td><td>设计者</td></tr><tr><td>license</td><td>string</td><td>使用协议地址</td></tr><tr><td>tags</td><td>string</td><td>字体标签</td></tr><tr><td>languages</td><td>string</td><td>字体适用语言</td></tr><tr><td>category</td><td>string</td><td>字体分类</td></tr><tr><td>created\_at</td><td>string</td><td>创建时间</td></tr><tr><td>updated\_at</td><td>string</td><td>更新时间</td></tr></tbody></table>

</figure>#### [](#bkmrk-%E4%B8%8B%E9%9D%A2%E6%98%AF%E4%B8%80%E4%B8%AA%E8%AF%A6%E7%BB%86%E7%9A%84%E8%BF%94%E5%9B%9E%E6%95%B0%E6%8D%AE%E4%BE%8B%E5%AD%90)下面是一个详细的返回数据例子

```
{
  "code": 200,
  "data": {
    "page": "number",
    "total": "number",
    "pageTotal": "number",
    "dataList": [
      {
        "name": "string",
        "fontFamily": "string",
        "fontSubfamily": ["string"],
        "version": "string",
        "copyright": "string",
        "description": "string",
        "designer": "string",
        "license": "string | null",
        "category": "string",
        "tags": "string",
        "languages": "string",
        "id": "string",
        "created_at": "date",
        "updated_at": "date"
      }
    ]
  },
  "message": "success"
}

```