misskey/packages/misskey-js/generator
おさむのひと c81b61eb2e
fix(misskey-js): 自動生成物の冒頭からバージョンと日付を削除 (#13185)
2024-02-06 21:03:29 +09:00
..
src fix(misskey-js): 自動生成物の冒頭からバージョンと日付を削除 (#13185) 2024-02-06 21:03:29 +09:00
.eslintrc.cjs バックエンドが生成するapi.jsonからmisskey-jsの型を作成する (#12434) 2023-12-02 21:00:05 +09:00
.gitignore バックエンドが生成するapi.jsonからmisskey-jsの型を作成する (#12434) 2023-12-02 21:00:05 +09:00
README.md バックエンドが生成するapi.jsonからmisskey-jsの型を作成する (#12434) 2023-12-02 21:00:05 +09:00
package.json fix(backend): 虚無ノートを投稿できる問題の修正と `api.json` の OpenAPI Specification 3.1.0 への対応 (#12969) 2024-01-13 16:54:25 +09:00
tsconfig.json バックエンドが生成するapi.jsonからmisskey-jsの型を作成する (#12434) 2023-12-02 21:00:05 +09:00

README.md

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を入手したら、このファイルがあるディレクトリに置いてください。

その後、以下コマンドを実行します。

pnpm generate

上記を実行することで、./builtディレクトリ配下にtsファイルが生成されます。