webentwicklung-frage-antwort-db.com.de

Wie formatiere ich Swagger 2.0-Textbeschreibungen?

Ich möchte meine Swagger-API-Beschreibungen so formatieren, dass es sich nicht um einfache Textabschnitte handelt. Am liebsten würde ich ihm einen kleinen Tisch hinzufügen.

Ich habe keine Online-Referenz zur Textformatierung in den Swagger-Beschreibungen gefunden. Wenn ich Swagger Editor starte und das Instagram-Beispiel öffne (File\Open Example\Instagram.yaml), wird in der ersten Beschreibung der Yaml-Datei eine Formatierung einschließlich eines Hyperlinks und eines Begrenzungsrahmens angezeigt:

    [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
```

Dies sieht aus wie Standard Markdown , aber wenn ich der Beschreibung der Beispiele eine Tabellenmarkierung hinzufüge, zeigt der Editor einen Fehler an:

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


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

Welche Formatierung erlaubt Swagger 2.0? Mache ich etwas falsch, um eine Tabelle zu rendern?

28
TERACytE

Markdown wird im Swagger Editor unterstützt. Unten sehen Sie ein Beispiel für die Verwendung von Markdown in einem OpenAPI-Dokument (Swagger):

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

Sie können das obige Beispiel kopieren und in Swagger Editor einfügen, um die Ausgabe zu sehen.

69
Wilson