> developers

日本語

English
简体中文

日本語

English
简体中文

Naming Convention API ​

Naming Convention API は、CoinPost の命名ルールに基づいて記事内のエンティティ名を検査します。

Base URL ​

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

認証方式 ​

API キーを CP-X-API-KEY ヘッダーで送信します。

text
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 とされた修正のみを適用します。修正後の記事データを返しますが、外部の記事システムの更新や違反の保存は行いません。