Configurar a API

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.

Abra o arquivo custom-config.json
Busque pela configuração openApiPluginConfig
Configure os parâmetros:
1. id: ID único para a sua documentação de API
2. docsPluginId: Mantenha como classic
3. api-name: Nome da sua API, será utilizada para geração dos arquivos MDX. Não deve possuir espaços, acentos ou caracteres especiais.
4. specPath: Caminho e nome do arquivo .json. Aqui padronizamos para sempre utilizar a pasta specs
5. outputDir: Caminho onde os arquivos serão salvos dentro da pasta docs. Não é necessário que você crie a pasta, apenas indique o caminho, por exemplo: docs/petstore
6. sidebarOptions: A configuração groupPathsBy serve para utilizar as tags configuradas no arquivo de especificação para agrupamento dos endpoints
Ao final teremos a seguinte configuração

custom-config.json
"openApiPluginConfig": {
    "id": "petstore",
    "docsPluginId": "classic",
    "config": {
      "petstore": { // Nome da API
        "specPath": "specs/petstore.swagger.io-v2.json",
        "outputDir": "docs/petstore",
        "sidebarOptions": {
          "groupPathsBy": "tag"
        }
      }
    }
  }

Utilizar mais de uma API

Se o seu projeto possuí mais de uma API, você pode configurar o arquivo para gerar o conteúdo MDX. Basta adicionar uma nova configuração, alterando as informações:

api-name: Nome da sua API, será utilizada para geração dos arquivos MDX
specPath: Caminho e nome do arquivo .json. Aqui padronizamos para sempre utilizar a pasta specs
outputDir: Caminho onde os arquivos serão salvos dentro da pasta docs. Não é necessário que você crie a pasta, apenas indique o caminho, por exemplo: docs/petowner
Ao final teremos a seguinte configuração

custom-config.json
"openApiPluginConfig": {
    "id": "petstore",
    "docsPluginId": "classic",
    "config": {

      // Api PETSTORE
      "petstore": { // Nome da API
        "specPath": "specs/petstore.swagger.io-v2.json",
        "outputDir": "docs/petstore",
        "sidebarOptions": {
          "groupPathsBy": "tag"
        }
      },

      // Api PETOWNER
      "petowner": { // Nome da API
        "specPath": "specs/petowner.swagger.io-v2.json",
        "outputDir": "docs/petowner",
        "sidebarOptions": {
          "groupPathsBy": "tag"
        }
      }

    }
  }

O próximo passo é Gerar os arquivos MDX.

Utilizar mais de uma API​

Utilizar mais de uma API