2015-01-26 19 views
8

Ben Swagger editörü değişmez bir çok hat almak için çalışıyorum (bu arada müthiş bir araç,!). Ben bunu denedimBiçimlendirici editörde çok satırlı editörler mi?

post: 
    summary: Translate one or more identifiers 
    description: | 
Translate one or more identifiers for one entity into the 
identifiers of another entity. Translate one or more 
identifiers for one entity into the identifiers of another entity. 

    consumes: 
    - application/json 

| ve>, farklı sonlar (boş çizgi vs artan girinti) ve Aklıma gelen her şekilde, ama hep aynı hatayı veriyor ile:

YAML Syntax Error 
Can not read a block mapping entry; a multiline key may not be an implicit 
key at line 24, column 15: consumes:^

Sorunun belirtmek JS-YAML için böcek bakın Sonunda, HTML textareas oluşturabildiğini bildiğim bir Windows tarzı yeni satır. Bu yüzden sadece beni yanlış bir şey, ya da Swagger editörü bir hata yapıyor, gerçekten çok YAML kullanıyorum ilk defa?

cevap

17

Sorunun size açıklama blokta metni başladı yolu olduğuna inanıyoruz. Bu açıklama sağında bir seviye girintili olmalıdır: İşte benim için çalışıyor şeyin bir örnek:

/{user-id}: 
get: 
    summary: Facebook User 
    description: | 
    Displays all information about a Facebook user, depending on access privileges. Displays all information about a Facebook user, depending on access privileges. 
    parameters: 
    - name: user-id 
     in: path 
     description: The Facebook user ID 
     required: true 
     type: string 

Benim asıl kodunda, açıklama üç satır uzunluğundadır.

+1

İyi göstermek ... teşekkürler! Bu ayrıntı YAML spesifikasyonunda hiç açık değildir. – fool4jesus

1

JSON yaklaşımını katmak istedi. Çift sözdizimi (öğrenme, ayıklama, web documentation için ayrıştırma, vs.) ile ilgili sorunları önlemek için Swagger Editör saf JSON kullanıyorum. çift ​​satır karakteri \n gibiydi Nedense

"get": { 
    "description": "Hi\n\nThere", 

yeni hat Swagger Editör üzerinde işlemek için en az için, gerekli olması. Ancak, resmi Uber API YAML demo'u JSON (Dosya -> JSON olarak indir) olarak dışa aktardığımda, sonuçta elde edilen JSON yalnızca çok satırlı değişmezlerin gösterildiği tek satırsonu karakterlerine sahipti. Tuhaf.