Naming Convention API

Naming Convention API 按 CoinPost 命名规则检查文章中的实体名称。

Base URL

https://api.coinpost.ai/naming-convention/v1

鉴权方式

通过 CP-X-API-KEY 请求头传递 API Key。

CP-X-API-KEY: <your-api-key>

接口

• POST /articles/scan — 查找命名违规并返回修正预览
• POST /articles/apply — 应用允许自动执行的命名修正

文章字段

服务检查 title、summary、content 和 tags。content 和 tags 是可选项。language 只支持 en、zh 和 ja。

匹配和修正结果中的位置是 UTF-8 字节偏移量，不是字符下标。

行为说明

• /articles/scan 默认保存检测到的违规记录；将 persist 设为 false 可关闭保存。
• /articles/scan 返回的 corrected_article 只是预览，其中可能包含需要人工确认的修正。
• /articles/apply 只应用规则中 auto_fix=true 的修正。它返回修正后的文章数据，但不会更新外部文章系统，也不会保存违规记录。