POST parametrelerini Apiary ile nasıl belgeleyebilirsiniz?

Question

Ben "bukle olarak eklenebilir" olacak şekilde tasarlanmıştır küçük bir web hizmeti yazdım, bu yüzden, POST istekleri application/x-www-form-urlencoded parametrelere örneğin dayanır:

Ben Apiary kullanarak bu hizmeti belgelemek istiyoruz

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

, ancak bu parametreler için yapılandırılmış belgeler sağlamanın bir yolunu bulamadım. Böyle bir örnek isteği sağlayabilir ...

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

     param1=foo&param2=bar 

... ama bu bana bireysel parametrelere belgeleri temin izin vermez (ve apiary konsolda test yapılması uygundur gelmez Çünkü, çeşitli parametreler için girdi alanları sağlayamıyor).

api blueprint specification'u birkaç kez okudum ve iyi bir çözüm bulamadım. Bu parametreler için yapılandırılmış belgeler sağlamak için herhangi bir yolu var mı?

Answer 1

Bu tür açıklama için Attributes kullanabilirsiniz.

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