API（エンドポイント）ドキュメント

kakkokari-gtyih commented 12 months ago

一応api.jsonからドキュメント生成できるようにするやつを作成中（api-doc-genブランチ）だが、HQのほうで作業をやってるのでそれを待ったほうがいい気がしている

kakkokari-gtyih commented 12 months ago

ただHQの作業があまり進んでないのならこっちで入力用のフォーマットをある程度用意してしまうのも手（Notionからのエクスポートに比べて、今後の反映がやりやすくなる）

kakkokari-gtyih commented 12 months ago

（どっちにしろ私のリソース的にしばらく手を付けられなさそう）

kakkokari-gtyih commented 11 months ago

ただHQの作業があまり進んでないのならこっちで入力用のフォーマットをある程度用意してしまうのも手（Notionからのエクスポートに比べて、今後の反映がやりやすくなる）

各リクエスト・レスポンスのKeyにそれぞれ１文付けられるようなJSONを出力できるように作業中

{
    "data": {
        "post": {
            "description": "（説明がありません）",
            "requestBody": {
                "userId": "（説明がありません）"
            },
            "response": null
        }
    },
    "title": "users/achievements"
}

（あとはHQにいい感じの編集ツールか何か用意してもらいたい気分（←ただ疲れて用意する気力がないだけ））

kakkokari-gtyih commented 11 months ago

とりあえずJSONができた

~~ここにおいてあります~~

せつめい

エンドポイントごとにファイルが分かれている。中身はこんな感じ

{
    "data": {
        "post": {
            "description": "（説明がありません）",
            "requestBody": {
                "visibility": "（説明がありません）",
                "visibleUserIds": "（説明がありません）",
                "cw": "（説明がありません）",
                "localOnly": "（説明がありません）",
                "reactionAcceptance": "（説明がありません）",
                "noExtractMentions": "（説明がありません）",
                "noExtractHashtags": "（説明がありません）",
                "noExtractEmojis": "（説明がありません）",
                "replyId": "（説明がありません）",
                "renoteId": "（説明がありません）",
                "channelId": "（説明がありません）",
                "text": "（説明がありません）",
                "fileIds": "（説明がありません）",
                "mediaIds": "（説明がありません）",
                "poll": "（説明がありません）"
            },
            "response": {
                "createdNote": "（説明がありません）"
            }
        }
    },
    "title": "notes/create",
    "description": "（説明がありません）"
}

data.post 以下とdescriptionの「説明がありません」を全部埋めていってもらえると、各キーの説明欄が完成するしくみ（titleは変更しないこと）

kakkokari-gtyih commented 11 months ago

当面はエンドポイントドキュメントのi18nは見送って、HQのJSONファイル記載が終わってからCrowdinに回すのがベストかと思った

kakkokari-gtyih commented 11 months ago

APIスキーマを表示するコンポーネントを作る必要があるけど難解すぎるのできつい（一応、$refで参照されてるスキーマをDynamic Importするための準備工事までは終わっている）

kakkokari-gtyih commented 11 months ago

（あとはHQにいい感じの編集ツールか何か用意してもらいたい気分（←ただ疲れて用意する気力がないだけ））

ファイルベースCMSのKeystaticを導入するのが良いかもしれない（Nuxtへのインテグレーションがまだできてないので待つ必要がある）

https://github.com/thinkmill/keystatic

kakkokari-gtyih commented 11 months ago

別ポートでCMSを立ち上げるのが良いっぽい https://github.com/Thinkmill/keystatic/issues/800 https://github.com/Thinkmill/keystatic/discussions/809

kakkokari-gtyih commented 10 months ago

HQの進捗がわからん

misskey-dev / misskey-hub-next

API（エンドポイント）ドキュメント #20

せつめい