diff options
author | umi <57262844+umi-umi@users.noreply.github.com> | 2020-09-04 11:54:23 +0900 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-09-03 19:54:23 -0700 |
commit | c3f3b34d7c913df771f9cd6470169798a2ece16f (patch) | |
tree | d58518c6b0cf55912936ba915e0ac25d34f649f5 /docs/ja/api_docs.md | |
parent | 98278968b75ffe48fdb4c0189658de00b7e4322c (diff) | |
download | qmk_firmware-c3f3b34d7c913df771f9cd6470169798a2ece16f.tar.gz qmk_firmware-c3f3b34d7c913df771f9cd6470169798a2ece16f.zip |
[Docs] Japanese translation of api_*.md (#9992)
* add api related translation
* update based on comment
* update based on comment
* update based on comment
Diffstat (limited to 'docs/ja/api_docs.md')
-rw-r--r-- | docs/ja/api_docs.md | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/docs/ja/api_docs.md b/docs/ja/api_docs.md new file mode 100644 index 000000000..b483c045e --- /dev/null +++ b/docs/ja/api_docs.md | |||
@@ -0,0 +1,73 @@ | |||
1 | # QMK API | ||
2 | |||
3 | <!--- | ||
4 | original document: 0.9.50:docs/api_docs.md | ||
5 | git diff 0.9.50 HEAD -- docs/api_docs.md | cat | ||
6 | --> | ||
7 | |||
8 | このページは QMK API の使い方を説明します。もしあなたがアプリケーション開発者であれば、全ての [QMK](https://qmk.fm) キーボードのファームウェアをコンパイルするために、この API を使うことができます。 | ||
9 | |||
10 | ## 概要 | ||
11 | |||
12 | このサービスは、カスタムキーマップをコンパイルするための非同期 API です。API に 何らかの JSON を POST し、定期的に状態をチェックし、ファームウェアのコンパイルが完了していれば、結果のファームウェアと(もし希望すれば)そのファームウェアのソースコードをダウンロードすることができます。 | ||
13 | |||
14 | #### JSON ペイロードの例: | ||
15 | |||
16 | ```json | ||
17 | { | ||
18 | "keyboard": "clueboard/66/rev2", | ||
19 | "keymap": "my_awesome_keymap", | ||
20 | "layout": "LAYOUT_all", | ||
21 | "layers": [ | ||
22 | ["KC_GRV","KC_1","KC_2","KC_3","KC_4","KC_5","KC_6","KC_7","KC_8","KC_9","KC_0","KC_MINS","KC_EQL","KC_GRV","KC_BSPC","KC_PGUP","KC_TAB","KC_Q","KC_W","KC_E","KC_R","KC_T","KC_Y","KC_U","KC_I","KC_O","KC_P","KC_LBRC","KC_RBRC","KC_BSLS","KC_PGDN","KC_CAPS","KC_A","KC_S","KC_D","KC_F","KC_G","KC_H","KC_J","KC_K","KC_L","KC_SCLN","KC_QUOT","KC_NUHS","KC_ENT","KC_LSFT","KC_NUBS","KC_Z","KC_X","KC_C","KC_V","KC_B","KC_N","KC_M","KC_COMM","KC_DOT","KC_SLSH","KC_RO","KC_RSFT","KC_UP","KC_LCTL","KC_LGUI","KC_LALT","KC_MHEN","KC_SPC","KC_SPC","KC_HENK","KC_RALT","KC_RCTL","MO(1)","KC_LEFT","KC_DOWN","KC_RIGHT"], | ||
23 | ["KC_ESC","KC_F1","KC_F2","KC_F3","KC_F4","KC_F5","KC_F6","KC_F7","KC_F8","KC_F9","KC_F10","KC_F11","KC_F12","KC_TRNS","KC_DEL","BL_STEP","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","_______","KC_TRNS","KC_PSCR","KC_SLCK","KC_PAUS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(2)","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_PGUP","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(1)","KC_LEFT","KC_PGDN","KC_RGHT"], | ||
24 | ["KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","RESET","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(2)","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(1)","KC_TRNS","KC_TRNS","KC_TRNS"] | ||
25 | ] | ||
26 | } | ||
27 | ``` | ||
28 | |||
29 | ご覧のとおり、ペイロードにはファームウェアを作成および生成するために必要なキーボードの全ての側面を記述します。各レイヤーは QMK キーコードの1つのリストで、キーボードの `LAYOUT` マクロと同じ長さです。もしキーボードが複数の `LAYOUT` マクロをサポートする場合、どのマクロを使うかを指定することができます。 | ||
30 | |||
31 | ## コンパイルジョブのサブミット | ||
32 | |||
33 | キーマップをファームウェアにコンパイルするには、単純に JSON を `/v1/compile` エンドポイントに POST します。以下の例では、JSON ペイロードを `json_data` という名前のファイルに配置しています。 | ||
34 | |||
35 | ``` | ||
36 | $ curl -H "Content-Type: application/json" -X POST -d "$(< json_data)" http://api.qmk.fm/v1/compile | ||
37 | { | ||
38 | "enqueued": true, | ||
39 | "job_id": "ea1514b3-bdfc-4a7b-9b5c-08752684f7f6" | ||
40 | } | ||
41 | ``` | ||
42 | |||
43 | ## 状態のチェック | ||
44 | |||
45 | キーマップをサブミットした後で、簡単な HTTP GET 呼び出しを使って状態をチェックすることができます: | ||
46 | |||
47 | ``` | ||
48 | $ curl http://api.qmk.fm/v1/compile/ea1514b3-bdfc-4a7b-9b5c-08752684f7f6 | ||
49 | { | ||
50 | "created_at": "Sat, 19 Aug 2017 21:39:12 GMT", | ||
51 | "enqueued_at": "Sat, 19 Aug 2017 21:39:12 GMT", | ||
52 | "id": "f5f9b992-73b4-479b-8236-df1deb37c163", | ||
53 | "status": "running", | ||
54 | "result": null | ||
55 | } | ||
56 | ``` | ||
57 | |||
58 | これは、ジョブをキューに入れることに成功し、現在実行中であることを示しています。5つの状態がありえます: | ||
59 | |||
60 | * **failed**: なんらかの理由でコンパイルサービスが失敗しました。 | ||
61 | * **finished**: コンパイルが完了し、結果を見るには `result` をチェックする必要があります。 | ||
62 | * **queued**: キーマップはコンパイルサーバが利用可能になるのを待っています。 | ||
63 | * **running**: コンパイルが進行中で、まもなく完了するはずです。 | ||
64 | * **unknown**: 深刻なエラーが発生し、[バグを報告](https://github.com/qmk/qmk_compiler/issues)する必要があります。 | ||
65 | |||
66 | ## 完了した結果を検証 | ||
67 | |||
68 | コンパイルジョブが完了したら、`result` キーをチェックします。このキーの値は幾つかの情報を含むハッシュです: | ||
69 | |||
70 | * `firmware_binary_url`: 書き込み可能なファームウェアの URL のリスト | ||
71 | * `firmware_keymap_url`: `keymap.c` の URL のリスト | ||
72 | * `firmware_source_url`: ファームウェアの完全なソースコードの URL のリスト | ||
73 | * `output`: このコンパイルジョブの stdout と stderr。エラーはここで見つけることができます。 | ||