é possível colocar uma imagem na descrição da documentação? | Swagger: documentando suas APIs | Alura - Cursos online de tecnologia

Entrar Ainda não tem acesso?

Importante

Você está vendo a versão anterior da nova experiência da Alura que estamos preparando para você. Em breve, ela ganha uma identidade visual novinha totalmente pensada em potencializar seus estudos!

1
resposta

Referente ao curso Swagger: documentando suas APIs, no capítulo Conhecendo a ferramenta e atividade Swagger Editor

por Marcela Espindola

| 1.8k xp | 1 posts

é possível colocar uma imagem na descrição da documentação?

1 resposta

por Vinícius Louzada

| 865.3k xp | 1357 posts

29/05/2023

Olá, Marcela. Tudo bem?

Gostaria de pedir desculpas pela demora em responder o seu tópico.

Sim, é possível adicionar uma imagem na descrição, uma das formas é usando Markdown:

A sintaxe básica para adicionar uma imagem em Markdown é a seguinte:

![Texto alternativo](URL_da_imagem)

Em um exemplo no arquivo YAML ficaria assim:

openapi: 3.0.1
info:
  title: API Aluraflix
  description: API para gerenciar os vídeos favoritos de um usuário.
    ![Logo Swagger](https://raw.githubusercontent.com/swagger-api/swagger.io/wordpress/images/assets/SWE-logo-clr.png)
  version: 0.0.1
  contact:
    name: Vinicius Louzada

Espero ter ajudado, caso tenha mais dúvidas estou à disposição. Bons estudos!

Caso este post tenha lhe ajudado, por favor, marcar como solucionado ✓