Pular para o conteúdo principal

Gerar os arquivos MDX

Os arquivos MDX serão os arquivos finais da documentação, onde o usuário poderá interagir com os endpoints.

Instalar o Yarn​

  1. Abra o terminal ctrl|cmd + ' no VS Code
  2. Execute o comando npm install --global yarn

Gerar os arquivos MDX​

  1. Abra o terminal ctrl|cmd + ' no VS Code
  2. Digite o comando yarn docusaurus gen-api-docs <id>
informação

Altere o <id> para o nome da api. Em nosso caso yarn docusaurus gen-api-docs petstore.

  1. Você deverá receber a informação que os arquivos foram gerados com sucesso e, uma nova pasta em docs será criada.

O próximo passo é Disponibilizar a API no menu lateral.

Atualizar os arquivos MDX​

Se você fez alguma alteração em seu arquivo de especificação, é possível atualizar os arquivos MDX. Para isso é necessário remover todos os arquivos e gerar novamente.

Para remover, execute o comando yarn docusaurus clean-api-docs <id> logo execute o comando yarn docusaurus gen-api-docs <id> para gerar os arquivos atualizados.

informação

Altere o <id> para o nome da api.