SEO Settings#
Apidog provides a SEO feature for API documentation, enabling you to optimize your API documentation for search engines and attract more traffic.Apidog Version >= 2.6.25 is required.
You can access the SEO settings by clicking theSEO Settingsicon on the right side of the endpoint documentation or Markdown pages.URL Slug#
You can create custom URL slugs for your endpoints, Markdown documents, and folders, making them more search engine-friendly. Once a slug is set, the URL for the page in the shared API documentation will appear as:https://your-domain.com/{slug}.If you have configured a custom domain for your published docs, the custom URL in the settings will display as that designated domain.
URL Rules#
On the API document publishing setting page, you can access theproject settingsto review the current URL rules.After clicking, you will be directed to theURL Rulespage, where you can customize the relevant rules.For newly published documents, the system will automatically apply redirects when URL rules are modified.
For existing data, the system will automatically apply redirects when the resourceKey specification is changed.
Docs Redirect Rules#
If you need to change an existing slug in your documentation, you can set up redirect rules to ensure users can still access the correct documents and avoid broken links.On the document publishing settings page, you can configure multiple redirect rules. When users access the old slug, the system will automatically redirect them to the new slug.
