Um arquivo de especificação de API no formato JSON é um documento estruturado que descreve os detalhes de uma API, incluindo seus endpoints, métodos, parâmetros, tipos de resposta e autenticação. Esses arquivos são comumente usados com OpenAPI (Swagger) para padronizar e facilitar a comunicação entre sistemas e desenvolvedores.
A configuração serve para indicarmos onde está o arquivo de especificação e onde serão gerados os arquivos MDX. Além de informações importantes como ID e Nome da API.
Assim como os arquivos Markdown, devemos disponibilizar o acesso a API através do Menu lateral.
Os arquivos MDX serão os arquivos finais da documentação, onde o usuário poderá interagir com os endpoints.
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.
Se você não precisar mais da referência de uma API, basta removê-la executando o comando yarn docusaurus clean-api-docs . Isso eliminará todos os arquivos MDX relacionados à API especificada.