2016-11-17 13 views
0

SmartDocsのスッゲッガ仕様のパラメータのnameプロパティにエイリアスを設定して別の値を表示する方法はありますか?例えばSwaggerの仕様 - SmartDocs - パラメータの名前 - エイリアス

parameters: 
    - name: consumer_key 
    in: formData 
    description: >- 
    Your Consumer Key (from My Apps) 
    required: true 
    type: string 

要求を送信する、それが実際にCONSUMER_KEYを送る= ABCではなくCLIENT_ID = ABC。私がこれをやろうとする理由は、デベロッパーアプリケーションを正常に登録した後に、デベロッパーは(クライアントIDとして)consumer_keyを取得します。

また、「this client_idはあなたのアプリのconsumer_keyです」という記述フィールドにマップすることもできます。何かのようなものですが、名前のフィールドに「エイリアス」を設定する方法があるかどうかを確認したいと思います。

enter image description here

答えて

0

闊歩はパラメータのための別名をサポートしていません。また、ドキュメントが実際のリクエストとは異なるパラメータ名を使用すると、開発者を混乱させる可能性があります。

descriptionを使用して、パラメータ値の元の場所を説明します。これで十分です。

関連する問題