Wie format Swagger 2.0-text-Beschreibungen?

Möchte ich formatieren, meine Swagger API-Beschreibungen, so dass Sie nicht einfach Absätze von text. Vorzugsweise würde ich gerne fügen Sie eine kleine Tabelle.

Habe ich nicht gefunden, eine online-Referenz zur text-Formatierung in Swagger-Beschreibungen. Wenn ich starte den Swagger-Editorund öffnen Sie die Instagram-Beispiel (Datei \ Öffnen Beispiel \ Instagram.yaml), sehe ich das die erste Beschreibung in der yaml-Datei zeigt einige Formatierungen, einschließlich einen hyperlink und bounding-box:

    [registered your client](http://instagram.com/developer/register/) it's easy
to start requesting data from Instagram.

```
  https://api.instagram.com/v1/media/popular?client_id=CLIENT-ID
```

Dieser sieht aus wie standard Markdownaber wenn ich eine Tabelle hinzufügen markdown zu den Proben Beschreibung der editor stellt einen Fehler:

|Col1|Col2|
|------ | ------|
|1|2|


YAML Syntax Error
End of the stream or a document separator is expected at line 36, column

Welche Formatierung hat Swagger 2.0 ermöglichen?
Mache ich etwas falsch zu machen eine Tabelle?

InformationsquelleAutor der Frage TERACytE | 2016-10-07

  1. 41

    Markdown wird unterstützt, in dem Swagger-Editor. Unten ist ein Beispiel der Verwendung von Markdown in einem Open API (Fors) Dokument:

    swagger: '2.0'
info:
  version: 0.0.0
  title: Markdown 
  description: |
    # Heading

    Text attributes _italic_, *italic*, __bold__, **bold**, `monospace`.

    Horizontal rule:

    ---

    Bullet list:

      * apples
      * oranges
      * pears

    Numbered list:

      1. apples
      2. oranges
      3. pears

    A [link](http://example.com).

    An image:
    ![Swagger logo](https://raw.githubusercontent.com/swagger-api/swagger-ui/master/dist/favicon-32x32.png)

    Code block:

    ```
    {
      "message": "Hello, world!"
    }
    ```

    Tables:

    | Column1 | Collumn2 |
    | ------- | -------- |
    | cell1   | cell2    |
paths:
  /:
    get:
      responses:
        200:
          description: OK

    Können Sie kopieren und kopieren Sie das obige Beispiel, um die Swagger-Editor um die Ausgabe zu sehen.

    InformationsquelleAutor der Antwort Wilson

Schreibe einen Kommentar