Come documentare i parametri POST con Apiary?

Question

Ho scritto un servizio web di piccole dimensioni che è stato progettato per essere "curl-grado", in modo che si basa su parametri application/x-www-form-urlencoded in POST richieste, ad esempio:

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

vorrei documentare questo servizio utilizzando Apiary, ma non sono riuscito a trovare un modo per fornire documentazione strutturata per questi parametri. Posso fornire un esempio di richiesta come questo ...

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

     param1=foo&param2=bar 

... ma questo non mi permette di fornire la documentazione sul singoli parametri (e non si presta bene ai test nella console apiario , dal momento che non è in grado di fornire campi di input per i vari parametri ).

Ho letto lo api blueprint specification alcune volte e non sono riuscito a trovare una buona soluzione. C'è un modo in cui lo fornisce documentazione strutturata per questi parametri?

Answer 1

È possibile utilizzare Attributes per questa descrizione del tipo.

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