Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

swagger-cli validateがvalidとなるapi.jsonを作れるようにしたい #12402

Closed
samunohito opened this issue Nov 21, 2023 · 2 comments
Closed
Labels
packages/backend Server side specific issue/PR

Comments

@samunohito
Copy link
Member

(機能要望でもバグ報告でもないので、空のテンプレートで失礼します)

概要

Misskey本体にはOpenAPI形式のjsonを作成する機能が備わっており、実際に型やクライアントの自動生成ツールに読み込ませて使用できます。しかし、同時に以下の問題点を抱えています。

  1. 書式的には完全な状態ではなくswagger-cli validateにて解析すると大量の警告が出る
  2. 認証が必要なエンドポイントにおいて、トークンをもたせるiを含んだ形でエンティティを作れない

これらはユーザに直接影響のあるものではありませんが、サードパーティアプリの開発者にとっては以下の点が懸念になると思います。

  1. OpenAPIに対応した生成ツールによっては生成時に警告が出そう
    →もし思い通りに作られない箇所があった時、原因の特定が大変になる可能性(警告が多いので)
  2. iを持たせるには一度any化するか(js/tsの場合)、オブジェクトをラップするか(java、C#など)などの細工が必要になる

などの点が考えられます。

対象ユーザ

Misskeyから生成したapi.jsonを使用する開発者各位

@samunohito
Copy link
Member Author

実装は自分がします。

@samunohito
Copy link
Member Author

マージ感謝:pray:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
packages/backend Server side specific issue/PR
Projects
None yet
Development

No branches or pull requests

2 participants