Nhiều dòng chữ trong trình chỉnh sửa vênh vang?

Question

Tôi đang cố gắng để có được một chữ nhiều dòng trong trình soạn thảo Swagger (công cụ tuyệt vời, bằng cách này!).

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 

Tôi đã thử nó với | và>, với kết thúc khác nhau (tăng thụt lề so với dòng trống), và mỗi cách tôi có thể nghĩ đến, nhưng nó luôn luôn cung cấp cho các lỗi tương tự:

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:^

tôi thấy lỗi cho JS-YAML mà chỉ ra vấn đề là một newline kiểu Windows ở cuối, mà tôi biết HTML textareas có thể tạo ra. Đây là lần đầu tiên tôi thực sự sử dụng YAML nhiều, vậy có phải chỉ là tôi đang làm điều gì sai, hay một lỗi trong trình soạn thảo của Swagger?

Answer 1

Tôi tin rằng vấn đề là cách bạn bắt đầu văn bản trên khối mô tả của mình. Nó phải được thụt lề một cấp ở bên phải của mô tả: Dưới đây là ví dụ về một cái gì đó phù hợp với tôi:

/{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 

Trong mã thực sự của tôi, mô tả dài ba dòng.

Answer 2

Muốn thêm phương pháp JSON. Tôi đang sử dụng JSON thuần túy trong Trình chỉnh sửa Swagger để tránh các vấn đề với cú pháp kép (tìm hiểu, gỡ lỗi, phân tích cú pháp cho web documentation, v.v.).

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

Đối với một số lý do đôi xuống dòng nhân vật \n dường như được yêu cầu, ít nhất là cho các dòng sản phẩm mới để hiển thị trên các Swagger Editor. Tuy nhiên, khi tôi xuất khẩu API chính thức của API YAML demo thành JSON (Tệp -> Tải xuống dưới dạng JSON), JSON kết quả chỉ có các ký tự dòng đơn mới trong đó các ký tự nhiều dòng được thể hiện. Kỳ dị.