web-dev-qa-db-ja.com

APIブループリントを使用したクエリパラメータの文書化

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を誤解しているだけですか、それともクエリパラメータを別の方法で文書化する必要がありますか？

apiblueprintapiary.io
16
Sebastian Dahlgren

ブループリントは完全に問題ありません。問題は、現在のApiaryドキュメントがURIパラメーターを正しく処理していないことです。

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

URI Parameters

編集

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

http://baasar.apiary-mock.com/user/{appId}/{userId}{?force}
18
Baggz

私のcurlリクエスト：

curl -k -u username:password https://api.techie8.io/api/1.0/bits?bit_type=1

Apiaryブループリント：

## Bits Collection [/bits?bit_type={bit_type}]

### List Latest bits [GET]

List all bits recently inserted into database.

+ Parameters
    + bit_type (number, optional, `1`) ... Type of bit to retrieve: 1: Bits, 2: Newsletter
0
gogasca