web-dev-qa-db-fra.com

Documentation des paramètres de requête avec l'API Blueprint

J'essaie de documenter un paramètre de requête dans l'API Blueprint, mais je ne suis pas tout à fait sûr de l'avoir correctement fait. La ressource ressemble à ceci:

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

Cette demande désactive l'utilisateur alors que ce qui suit supprime l'objet utilisateur:

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

Voici le plan détaillé que j'ai pour cela:

## 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

Cependant, lors du rendu avec Apiary, je ne vois que force dans la liste des paramètres, mais cela apparaît maintenant dans l'exemple d'URL. Est-ce juste que je comprends mal l'interface graphique ou est-ce que les paramètres de requête doivent être documentés d'une autre manière?

apiblueprintapiary.io
14
Sebastian Dahlgren

Votre plan est parfait, le problème est que la documentation actuelle de Apiary ne gère pas les paramètres URI correctement.

Pourriez-vous essayer la nouvelle documentation out? Il devrait gérer les paramètres URI correctement.

URI Parameters

Modifier

Le modèle d'URI correct devrait être:

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

Mon curl demande:

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

Plan du rucher: 

## 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
spicyramen