API

ETSO 提供公共 API,供其他项目查询目录中作品的元数据。该 API 可用于复用每部作品的标识符、标题、归属、链接和文体计量结果。

信息以 JSON 格式返回,可用于将 ETSO 数据整合到目录、可视化、搜索系统或研究工具中。

端点

GET /api/obras

返回完整作品目录及其公共元数据。

GET /api/obras/{id-o-slug}

使用作品标识符或公共 slug 返回单部作品。

主要字段

字段说明
id作品的稳定标识符。
slug公共 URL 中使用的可读标识符。
title数据库中的标题,包括存在时位于末尾的冠词。
displayTitle按照 ETSO 网站使用的同一流程转换后的标题。
titleVariants数据库中的其他作品标题。
displayTitleVariants按照网站同一流程转换后的其他标题。
genre作品体裁。
originETSO 使用文本的来源或出处。
textState目录中的文本状态。
addedOn加入目录的日期,如有记录。
resultado1作品的文体计量结果,以句子形式提供。
flags关于报告、摘要、作者归属检查和文本访问的布尔标记。
traditionalAttributionText可直接显示的传统归属。
traditionalAttributionPhrase包含文本、Markdown、HTML 和可链接片段的传统归属句。
stylometryAttributionText可直接显示的文体计量归属。
traditionalAttribution规范化的传统归属。
stylometryAttribution规范化的文体计量归属。
resourcesETSO 内部相关的公共链接。

推荐用法

响应使用公共缓存: public, max-age=3600, s-maxage=86400, stale-while-revalidate=604800. 外部集成建议在本地缓存响应,不要在每次渲染时调用 API。

示例

查询某一具体作品及完整响应:

https://etso.es/api/obras/la-francesa-laura
{
  "meta": {
    "contentPolicy": {
      "includesFullText": false,
      "includesSummaries": false,
      "excludedFields": [
        "fullText",
        "text",
        "shortSummary",
        "summaryText",
        "resumen_breve",
        "resumen_largo"
      ]
    }
  },
  "work": {
    "id": "DESCONOCIDO_FrancesaLaura",
    "slug": "la-francesa-laura",
    "title": "Francesa Laura, La",
    "displayTitle": "La francesa Laura",
    "titleVariants": [],
    "displayTitleVariants": [],
    "genre": "Comedia",
    "origin": "El texto procede de la edición de Cuéllar y Vega.",
    "textState": "Bueno",
    "addedOn": "2021/03",
    "resultado1": "Los analisis de estilometria permiten asociar esta obra de forma clara con el perfil autorial de Lope de Vega Carpio.",
    "flags": {
      "inAuthorshipExam": true,
      "hasSummary": true,
      "hasReport": true,
      "hasTextAccess": true
    },
    "traditionalAttributionText": "佚名",
    "traditionalAttributionPhrase": {
      "text": "归属 未知的作品.",
      "markdown": "归属 [未知的作品](https://etso.es/autores/desconocido).",
      "html": "归属 <a href=\"/autores/desconocido\">未知的作品</a>.",
      "parts": [
        {
          "kind": "text",
          "value": "归属 "
        },
        {
          "kind": "author",
          "value": "未知的作品",
          "authorId": "desconocido",
          "href": "/autores/desconocido",
          "url": "https://etso.es/autores/desconocido"
        },
        {
          "kind": "text",
          "value": "."
        }
      ]
    },
    "stylometryAttributionText": "Lope de Vega Carpio [确定]",
    "traditionalAttribution": {
      "groups": [
        {
          "members": [
            {
              "authorId": "desconocido",
              "authorName": "佚名"
            }
          ]
        }
      ],
      "connector": "and",
      "rawExpression": "desconocido"
    },
    "stylometryAttribution": {
      "groups": [
        {
          "members": [
            {
              "authorId": "vega_carpio_lope_de",
              "authorName": "Lope de Vega Carpio",
              "confidence": "segura"
            }
          ]
        }
      ],
      "connector": "and",
      "rawExpression": "vega_carpio_lope_de[segura]"
    },
    "resources": {
      "work": "/obras/la-francesa-laura",
      "summary": "/obras/la-francesa-laura/resumen",
      "report": "/informes/analisis-estilometrico-la-francesa-laura",
      "textAccess": [
        {
          "label": "文本 BITESO",
          "href": "/biteso/francesa-laura-la",
          "kind": "biteso"
        }
      ]
    }
  }
}