Referência de API
Se você escolheu o Docusaurus como sua ferramenta de documentação, é possível que você tenha uma API para que os usuários possam interagir. Veja um exemplo completo de uma Documentação de referência.
Como funciona no Docusaurus?
O Docusaurus possuí um plugin que realiza a conversão de arquivos de especificação de API (.json), em arquivos MDX prontos para interação.
- Primeiro você disponibiliza o arquivo .json para conversão
- Configura o plugin para receber e disponibilizar a referência
- Utiliza a CLI do plugin para converter em MDX
- Adiciona a referência ao menu lateral
Nós vamos seguir cada uma destas etapas utilizando um exemplo real. Começamos pelo arquivo de especificação.