Apidog は、グローバルなチーム体制や個人の好みに対応するため、3 つの異なる側面で柔軟な言語設定を提供しています。これらの設定を理解することで、ワークフローやチームコラボレーションに適した言語環境を構成できます。言語設定の概要#
| 設定タイプ | 範囲 | 変更できるユーザー | 影響対象 | オンラインドキュメントへの影響 |
|---|
| ソフトウェア言語 | 個人 | 個々のユーザー | ローカルインターフェースのみ | いいえ |
| プロジェクト言語 | プロジェクト全体 | 管理者のみ | すべてのチームメンバー向けの自動生成コンテンツ | はい |
| ドキュメント言語 | 共有ごと | 共有権限を持つユーザー | オンラインドキュメントのインターフェース | 該当なし(オンラインドキュメント自体) |
ソフトウェア言語#
ソフトウェア言語は、Apidog ソフトウェアインターフェースに表示される言語を決定します。これは 設定 → 一般 → ソフトウェア言語 から設定できます。この設定は個人用であり、他のチームメンバーやオンラインドキュメントに影響を与えることなく、ご自身のローカル環境にのみ影響します。ソフトウェア言語を英語に切り替えても、一部の要素はデフォルト言語で表示される場合があります。ここで プロジェクト言語 が関係し、自動生成コンテンツに影響します。
プロジェクト言語#
プロジェクト言語は、レスポンスのデフォルト名、例、API テストケース、Markdown ドキュメント、テストデータ内のデータセット名など、プロジェクト内の自動生成コンテンツに影響します。管理者のみが調整できるこの設定は、設定 → 基本設定 → プロジェクト言語 にあります。これはプロジェクトレベルで機能します。一度設定すると、オンラインドキュメントを含め、一貫性を保つためにすべてのチームメンバーが同じプロジェクト言語を使用します。プロジェクト言語を切り替えても、API ドキュメントに手動で入力されたデータは自動翻訳されません。翻訳には手動での対応が 必要です。
新規プロジェクトでプロジェクト言語を指定する#
新しいプロジェクトを開始する際、チームの希望言語に合わせてプロジェクト言語を設定できます。サンプルデータを含める を選択すると、ソフトウェア言語設定に一致する言語でデータが生成されます。ドキュメント言語#
ドキュメント言語は「オンラインドキュメント」に適用され、オンラインドキュメント向けのソフトウェア言語と考えることができます。この設定は、共有 → ドキュメントを共有 → 新規共有 → 言語 から利用できます。オンラインドキュメントは、言語設定の違いによって次のように表示されます。ベストプラクティス#
個々のユーザー: インターフェースに使用する希望言語として ソフトウェア言語 を設定します
チーム管理者: チームの主な作業言語に基づいて プロジェクト言語 を設定します
ドキュメント共有: ドキュメントを外部に共有する際は、対象読者に基づいて ドキュメント言語 を選択します