API ビジョン

属性

目標

GitLab API ビジョンワーキンググループは、現在の API を改善し、その将来の発展を定義することを目的としています。

概要

REST と GraphQL の API の間で、一貫したビューを持っていません。GraphQL API が GitLab とプログラマティックに対話する主要な手段であると定めていますが、しばしばこの基準に従っていません。両方の API は異なる機能セットをカバーしていますが、どちらも機能が完全ではありません。

目標

これは、私たちが議論したいトピックのリストです。

• 責任、Directly Responsible Individual、技術的エキスパート。現在、Manage:Integrations グループが API の DRI ですが、@graphql-experts グループも存在します。
• GitLab API の全般的なビジョン:
  • REST / GraphQL API の一貫性。
  • REST ファーストか、GraphQL ファーストか、別のアプローチか。
• API のレビュー:
  • 全般的なアーキテクチャ。
  • 権限とスコープ。
  • 機能カバレッジ。
  • パフォーマンス。
• テスト:
  • カバレッジ。
  • 自動テスト。
  • ツール（例: Postman コレクション）。
• API 非推奨化ライフサイクルと戦略:
  • REST v5 API またはさらなるイテレーション。
  • GraphQL 非推奨化プロセス。
• API 標準（OpenAPI 仕様を含む）。
• ドキュメント:
  • 現在のドキュメントを改善する。
  • 初めての API ユーザー体験をレビューする。
  • ドキュメントの自動化。
  • すべてのパブリック API と内部 API の完全なカタログ。
• 学習と貢献:
  • 貢献者向けドキュメントをレビューする。
  • チームメンバー向けの学習パスを作成する（特に GraphQL について）。

終了基準

以下の表に、ワーキンググループのすべての終了基準を示します。これは トップレベル epic です。

役割と責任

ページのソースコードを見る - ページの編集 - please contribute.