16

API ブループリントでクエリ パラメータを文書化しようとしていますが、それが正しく行われたかどうか完全にはわかりません。リソースは次のようになります。

DELETE http://baasar.apiary-mock.com/user/{appId}/{userId}

そのリクエストはユーザーを非アクティブ化しますが、次のリクエストはユーザー オブジェクトを削除します。

DELETE http://baasar.apiary-mock.com/user/{appId}/{userId}?force=true

これは私が持っているブループリントのマークダウンです:

## User [/user/{appId}/{userId}]
Handle user objects

+ Parameters
    + appId (required, number, `1`) ... Application ID (`appId`)
    + userId (required, number, `1`) ... Numeric `userId` of the User object to manage

### Remove an User [DELETE]
+ Parameters
    + force (optional, boolean, `false`) ... Set to `true` to remove instead of deactivate

+ Response 204

ただし、これを Apiary でレンダリングするとforce、パラメーターのリストにしか表示されませんが、サンプル URL に表示されるようになりました。GUIを誤解しているだけですか、それともクエリパラメータを別の方法で文書化する必要がありますか?

4

2 に答える 2

19

あなたの設計図はまったく問題ありません。問題は、現在の Apiary ドキュメントが URI パラメータを正しく処理していないことです。

新しいドキュメントを試していただけますか? URI パラメータを適切に処理する必要があります。

URI パラメータ

編集

正しい URI テンプレートは次のとおりです。

http://baasar.apiary-mock.com/user/{appId}/{userId}{?force}
于 2014-04-03T18:28:09.177 に答える