API Documentation

GET Generate Code

Generate i18n access code (TypeScript/JavaScript) from project translations.

URL: /api/gen

Query Parameters

Response

Type: text/plain

Returns generated code as plain text. The code includes:

• SUPPORT_LANGUAGES array
• defaultLanguage string
• texts object containing all translation texts organized by key and language
• Keys object with key constants
• T class with nested accessor classes
• Test functions (testAllKeys, testAllLanguages) for validating translations

Example Response

// Auto-generated by string.fit at 2026-05-28T01:45:15.149Z. Don't modify me manually.

import dayjs from "dayjs";
import utc from "dayjs/plugin/utc";
import timezone from "dayjs/plugin/timezone";

dayjs.extend(utc);
dayjs.extend(timezone);

export const SUPPORT_LANGUAGES = ["en-US", "zh-CN"];
export const defaultLanguage = "en-US";

// MARK: - Test Functions
export function testAllKeys(t: T): void {
    console.log(t.sign.in.login.button);
    // ... more keys
}

export function testAllLanguages(): void {
    for (const lang of SUPPORT_LANGUAGES) {
        const t = T.create(lang);
        console.log(`Testing ${lang}:`);
        testAllKeys(t);
    }
}

export const texts = { /* all translation texts by key and language */ };
export const Keys = { /* key constants */ };
// ... T class and nested classes

// Main call
testAllLanguages();

Status Codes

200 Success 401 Unauthorized

POST Import Strings

Import translation strings into a project.

URL: /api/import

Query Parameters

Headers

Authorization: Bearer <token> (if token not in query)
Content-Type: application/json

Request Body

{
  "strings": [
    {
      "key": "sign.in.login.button",
      "translations": {
        "zh-CN": {
          "content": "登录",
          "params": []
        },
        "en-US": {
          "content": "Login",
          "params": []
        }
      }
    }
  ]
}

Translation Object

Translation value can be either a simple string or an object with content and params:

// Simple string form
"content": "Hello World"

// Object form with params
{
  "content": "Hello @{name}, you have @{count} messages",
  "params": [
    { "paramName": "name", "type": "simple" },
    { "paramName": "count", "type": "number", "numberFormat": { "style": "decimal" } }
  ]
}

Note: Parameter placeholders use @{paramName} syntax, not {paramName}.

I18NParam Structure

The params array defines placeholders in the translation text. Each parameter has:

Parameter Types

I18NParamCondition (for select/plural/selectordinal)

{
  "value": string;   // The option value (e.g., "male", "one", "other")
  "text": string;    // The display text for this option
}

I18NNumberFormat (for number type)

{
  style?: string;              // e.g., "decimal", "currency", "percent"
  unit?: string;               // e.g., "kilogram", "meter", "byte"
  precisionMode?: 'fixed' | 'max';
  precisionLength?: number;
  compact?: string;            // e.g., "short", "long"
  percent?: string;            // e.g., "percent" (×100, appends %), "permille" (×1000, appends ‰)
  currency?: string;            // e.g., "USD", "CNY"
  format?: string;
}

Complete Request Example with Params

{
  "strings": [
    {
      "key": "user.greeting",
      "translations": {
        "zh-CN": {
          "content": "你好 @{name}，今天是 @{date}",
          "params": [
            { "paramName": "name", "type": "simple" },
            { "paramName": "date", "type": "date", "style": "full", "zoneId": "Asia/Shanghai" }
          ]
        },
        "en-US": {
          "content": "Hello @{name}, today is @{date}",
          "params": [
            { "paramName": "name", "type": "simple" },
            { "paramName": "date", "type": "date", "style": "full", "zoneId": "America/New_York" }
          ]
        }
      }
    },
    {
      "key": "product.count",
      "translations": {
        "zh-CN": "有 @{count} 个产品",
        "en-US": "@{count} products"
      }
    },
    {
      "key": "order.items",
      "translations": {
        "zh-CN": {
          "content": "您有 @{count}",
          "params": [
            { "paramName": "count", "type": "plural", "list": [
              { "value": "one", "text": "1 个项目" },
              { "value": "other", "text": "# 个项目" }
            ]}
          ]
        },
        "en-US": {
          "content": "You have @{count}",
          "params": [
            { "paramName": "count", "type": "plural", "list": [
              { "value": "one", "text": "1 item" },
              { "value": "other", "text": "# items" }
            ]}
          ]
        }
      }
    }
  ]
}

Note: Placeholders use @{paramName} syntax. For plural and select types, use list to define options with value (matching rule like one, other following ICU plural rules) and text (display text). The # symbol in text is a placeholder for the original numeric value — this is a model format, not an ICU message format string.

Response

{
  "code": 1000,
  "message": "success",
  "data": {
    "imported": 10,
    "totalStrings": 15,
    "createdKeys": 5,
    "skippedTranslations": [
      {
        "key": "sign.in.login.button",
        "languages": ["en-US"]
      }
    ],
    "conflicts": []
  }
}

Response Fields

Conflict Object

{
  key: string;           // The conflicting key
  reason: string;        // Reason for conflict
  suggestedKey?: string;  // Suggested alternative key
}

Status Codes

200 Success 400 Bad Request 401 Unauthorized

Constraints

• Maximum 3000 strings per batch
• Key format: only letters, numbers, . and _ allowed
• Key path depth: maximum 10 levels
• Intermediate nodes in path cannot be leaf nodes

401 Unauthorized

{
  "code": 401,
  "message": "Invalid or missing token"
}

400 Bad Request

{
  "code": 400,
  "message": "projectId is required"
}

cURL - Generate Code

curl -s -H "Authorization: Bearer <token>" \
  "https://string.fit/api/gen?projectId=33&codeLanguage=typescript" \
  -o T.ts

cURL - Import Strings

curl -s -X POST \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  "https://string.fit/api/import?projectId=33" \
  -d '{
    "strings": [
      {
        "key": "hello.world",
        "translations": {
          "zh-CN": "你好，世界",
          "en-US": "Hello, World"
        }
      }
    ]
  }'

JavaScript - Generate Code

const response = await fetch(
  `https://string.fit/api/gen?projectId=33&codeLanguage=typescript`,
  {
    headers: {
      'Authorization': `Bearer ${token}`
    }
  }
);
const code = await response.text();
console.log(code);

JavaScript - Import Strings

const response = await fetch(
  `https://string.fit/api/import?projectId=33`,
  {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      strings: [{
        key: 'hello.world',
        translations: {
          'zh-CN': { content: '你好，世界' },
          'en-US': { content: 'Hello, World' }
        }
      }]
    })
  }
);
const result = await response.json();
console.log(result);