1

API ブループリント レンダラーである Aglio では、リクエストの本文のパラメーターをエンドポイント仕様のパラメーター セクションに含めることはできません。次のように解析警告をスローします。

parameter '<some_parameter>' not specified in '<some_description>' its '<some_URI_template>' URI template (warning code 8)

この警告を再現する Markdown の例は次のとおりです。

## Journey creation [/v1/journeys/{origin}]

### Create journey [POST]
Create a new journey

+ Parameters
    + origin (required) ... origin location of journey
    + destination (required) ... destination location of journey

+ Request
    + Headers

                Accept: application/json
                Authorization: Basic <BASIC_AUTH_TOKEN>

    + Body

                {
                     "destination" : "some_other_place"
                }


+ Response 200 (application/json)

    + Body

            {
            "origin" : "some_place",
            "destination" : "some_other_place",
            "journey_state" : "Not_Started",
            "timestamp" : "<dateuuid>",
            }

URI テンプレートに含まれていないため、レンダリングされた 'destination' がパラメーターになることは好まれません。

私の質問は、これはツールの欠点ですか、それとも API ブループリントの仕様ですか? また、おそらく、この REST エンドポイントの定義は標準に準拠していないのでしょうか?

4

1 に答える 1

2

メッセージ本文の属性を指定する正しい方法は、Aglio 2.0 の時点で JSON および JSON スキーマをレンダリングするために使用される新しい MSON 属性構文を使用することです。

### Create journey [POST]
Create a new journey

+ Parameters
    + origin (required) - origin location of journey

+ Attributes
    + destination: some_other_place (required) - destination location of journey

+ Request
    + Headers

                Accept: application/json
                Authorization: Basic

近い将来、Aglio は属性の追加情報をレンダリングします。

于 2015-05-06T20:03:02.397 に答える