mirror of
https://activitypub.software/TransFem-org/Sharkey
synced 2024-11-25 15:35:12 +00:00
20 lines
994 B
Markdown
20 lines
994 B
Markdown
|
## misskey-js向け型生成モジュール
|
||
|
|
|
||
|
|
バックエンドが吐き出すOpenAPI準拠のapi.jsonからmisskey-jsで使用される型エイリアスを生成するためのモジュールです。
|
||
|
|
このモジュールはmisskey-jsそのものにバンドルされることは想定しておらず、生成物をmisskey-jsのsrc配下にコピーして使用することを想定しています。
|
||
|
|
|
||
|
|
## 使い方
|
||
|
|
|
||
|
|
まず、Misskeyのバックエンドからapi.jsonを取得する必要があります。任意のMisskeyインスタンスの/api-docからダウンロードしても良いですし、
|
||
|
|
backendモジュール配下で`pnpm generate-api-json`を実行しても良いでしょう。
|
||
|
|
|
||
|
|
api.jsonを入手したら、このファイルがあるディレクトリに置いてください。
|
||
|
|
|
||
|
|
その後、以下コマンドを実行します。
|
||
|
|
|
||
|
|
```shell
|
||
|
|
pnpm generate
|
||
|
|
```
|
||
|
|
|
||
|
|
上記を実行することで、`./built`ディレクトリ配下にtsファイルが生成されます。
|