メインコンテンツまでスキップ

共通パラメータ

tip

パラメータの説明を記入する作業は、多くのインターフェースが同じ名前や意味を持つパラメータを含む場合、手間がかかり非効率的になることがあります。毎回手動で入力する代わりに、パラメータ説明ライブラリを利用することで、この課題を解決できます。

image.png

パラメータ説明ライブラリの利用方法​

パラメータ説明ライブラリに一般的なパラメータの説明を事前に定義できます。たとえば、一般的なパラメータには次のようなものが含まれます。

{
    "name": "ユーザー名 ",
    "age": "ユーザー年齢",
    "email": "ユーザーのメールアドレス（通常ログインに使用）",
    "school": "ユーザーの学校"
}

image.png

事前に定義されたパラメータ名が使用されると、対応する説明が自動的に入力され、手動での入力が不要になります。同じパラメータに複数の説明が存在する場合は、ドロップダウンメニューから1つを選択できます。

image.png

システムには、簡単なトグルで有効にできる一連の組み込みパラメータ説明も含まれています。

image.png

パラメータ説明ライブラリの保存​

開発効率を向上させるために、パラメータ説明ライブラリを保存する方法は2つあります。

説明の自動抽出​

インターフェース設計やデバッグ中に入力されたパラメータ説明が、自動的に一時的なライブラリに保存されます。 ただし、一時保存されたデータはページをリフレッシュすると失われるため、データを永続化する場合は「保存」ボタンをクリックしてください。

image.png

image.png

パラメータ説明のインポート​

tip

キーと値の形式では、コロン（:）でキーと値を区切り（例：name: John Doe）、複数のレコードを改行で区切ります。

生のJSON形式では、標準のJSON構文を使用します。例えば：{"name": "John Doe", "age": 1}

//key-value example
name:ユーザー名 
age:ユーザー年齢
email:ユーザーのメールアドレス（通常ログインに使用）
school:ユーザーの学校
//raw-json example
{
    "name": "ユーザー名 ",
    "age": "ユーザー年齢",
    "email": "ユーザーのメールアドレス（通常ログインに使用）",
    "school": "ユーザーの学校"
}

image.png