Wie dokumentiert man POST-Parameter mit Imker?

Question

Ich habe einen kleinen Web-Service geschrieben, die "curl-able" wurde entwickelt, um, so setzt sie auf application/x-www-form-urlencoded Parameter in POST Anfragen, zB:

curl http://api.example.com/ -d param1=foo -d param2=bar 

ich diesen Dienst Apiary mit dokumentieren möchte, aber ich habe keine Möglichkeit gefunden, eine strukturierte Dokumentation für diese Parameter bereitzustellen. Ich kann ein Beispiel Anfrage wie diese bieten ...

+ Request (application/x-www-form-urlencoded) 

     param1=foo&param2=bar 

... aber dies erlaubt mir nicht, Dokumentation über die einzelnen Parameter zur Verfügung zu stellen (und nicht selbst gut in der Bienenhaus Konsole Tests verleihen , da es keine Eingabefelder für die verschiedenen Parameter geben kann).

Ich habe durch die api blueprint specification ein paar mal gelesen und ich konnte keine gute Lösung finden. Gibt es eine Möglichkeit strukturierte Dokumentation für diese Parameter bereitzustellen?

Answer 1

Sie können Attributes für diese Typbeschreibung verwenden.

FORMAT: 1A 

HOST: http://api.example.com/ 

# Test attributes 1 

## Create post [/] 

### Create a Post [POST] 

+ Attributes 
    + param1: foo (string) - Foo param 
    + param2: bar (string) - Bar param 

+ Request (application/x-www-form-urlencoded) 

+ Response 201