openapi-processor / openapi-processor/openapi-processor-base

map inline names to nicer names

オープン
#189 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

enhancement
主要言語
Kotlin
スター
2
フォーク
4
平均マージ
4日 55分
マージ済み PR(30日)
9

説明

  /bookings/{bookingId}/payment:
    post:
      responses:
        '200':

generates the response object as BookingsBookingIdPaymentPostResponse200.

Would it be useful to have the possibility to map that identifier to a nicer name?

mapping could use

  • json path to nice java name
  • generated java name to nice java name

the processor would have to warn if the inline name did not exists.

benefit:

it would not be necessary to define responses etc. as named schema to get a proper java class name

drawback:

harder to maintain?

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

ファイル、テスト、またはエントリーポイントが一つも指定されていません。まず、名前マッピングをどこで設定するのか、また JSON パスと生成された名前のどちらがサポート対象のキーなのかを明確にします。一致しないマッピングに対する警告の動作を定義してから、変更対象のジェネレーターコードとテストを特定してください。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
kotlin, openapi
領域
backend-api-design, tooling
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
30/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。