rest - validar - swagger yaml example
¿Cómo formatear las descripciones de texto de Swagger 2.0? (1)
Me gustaría formatear mis descripciones de Swagger API para que no sean párrafos simples de texto. Preferiblemente, me gustaría añadirle una mesa pequeña.
No encontré una referencia en línea sobre el formato de texto en las descripciones de Swagger. Si ejecuto el Editor Swagger y abro el ejemplo de Instagram (Archivo / Abrir ejemplo / Instagram.yaml), veo que la primera descripción en el archivo yaml muestra algunos formatos, incluido un hipervínculo y un cuadro delimitador:
[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
```
Parece un Markdown estándar, pero cuando agrego un markdown a la tabla a la descripción de las muestras, el editor presenta un error:
|Col1|Col2|
|------|------|
|1|2|
YAML Syntax Error
End of the stream or a document separator is expected at line 36, column
¿Qué formato permite Swagger 2.0? ¿Estoy haciendo algo mal para hacer una tabla?
Markdown es compatible con el Editor Swagger. A continuación se muestra un ejemplo del uso de Markdown en un documento OpenAPI (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:
Code block:
```
{
"message": "Hello, world!"
}
```
Tables:
| Column1 | Collumn2 |
| ------- | -------- |
| cell1 | cell2 |
paths:
/:
get:
responses:
200:
description: OK
Puede copiar y pegar el ejemplo anterior en Swagger Editor para ver el resultado.