diff --git a/api-playground/openapi/setup.mdx b/api-playground/openapi/setup.mdx index bbfdfe305..7d45da4f6 100644 --- a/api-playground/openapi/setup.mdx +++ b/api-playground/openapi/setup.mdx @@ -57,22 +57,19 @@ When using this option, the metadata for the generated pages will have the follo There are some scenarios in which the default behavior isn't sufficient. If you need more customizability, you can create an MDX page for your OpenAPI operation, and modify it just like any other MDX page. - ## Create MDX files for API pages If you want to customize the page metadata, add additional content, omit certain OpenAPI operations, or reorder OpenAPI pages in your navigation, you'll need an MDX page for each operation. Here is [an example MDX OpenAPI page](https://github.com/elevenlabs/elevenlabs-docs/blob/e5e267c97b8d1e4c21db1dcdb8b005eb1dfed7da/api-reference/speech-to-speech.mdx?plain=1#L2) from [Elevenlabs](https://elevenlabs.io/docs/api-reference/speech-to-speech). ![](/images/elevenlabs-mdx-autogeneration-example.png) - ### Autogenerate files For large OpenAPI documents, creating one MDX page for each OpenAPI operation can be a lot of work. To make it easier, we created a local OpenAPI page scraper. Our Mintlify [scraper](https://www.npmjs.com/package/@mintlify/scraping) autogenerates MDX files for your OpenAPI endpoints. Use the relative path to the -OpenAPI document in your codebase. If you're using a publicly-hosted OpenAPI -document, you can supply the URL in place of a path. +OpenAPI document in your codebase. ```bash npx @mintlify/scraping@latest openapi-file