in-house-swagger / in-house-swagger

in-house swagger-tools server

Home Page:https://in-house-swagger.github.io/in-house-swagger/index.html

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

editorからgeneratorのoptionを指定したい

suwa-sh opened this issue · comments

ストーリー

in-house-swaggerでAPIを公開する利用者 として
公開したAPIの利用者に、client sourceを生成してもらうために、
editorから、languageごとのoptionを指定 できる。

背景・経緯

generatorのAPIで /api/server/{lang} or /api/client/{lang} のGETで
langが対応しているOPTIONが返ってくる。

本格的に実現するならswagger hubに倣って

  • editorに専用のpopupを用意
  • langを選択して、対応しているoptionの入力フォームを生成
  • 入力内容を保存して、langに合わせたoptionで生成リクエスト
    ※swagger hubの場合、api proxyがいて、optionを保存しているっぽい

option指定しないと、デフォルト値で生成されてしまうので
editorからの生成を利用するなら、option指定は必須。
どこまでやるか。。。

まずは「指定できる状況」を用意しておきたい。

受け入れ条件

  1. language ごとにoptionを指定できること
  2. 各langのoptionの初回作成時は、languageに合わせたスキャフォルドが自動設定されること
  3. 設定したoptionでgenerateできること

対応詳細

  • editorにlangごとのgenerate optionを保存できる画面を用意
    • popupを追加

      • langを選択
      • 保存されていない場合
        • langのoptionをGET
        • 空のoption jsonを、popup内エディタに表示
        • 新規保存
      • 保存されている場合
        • 保存内容を、popup内エディタに表示
        • 上書き保存
    • 生成リクエスト時

      • 保存内容を、postのentity bodyに追加
        なければ空オブジェクト