Skip to main content

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.

seo settings on endpoint documentation

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}.

URL Slug

Note

If you have configured a custom domain for your published docs, the custom URL in the settings will display as that designated domain.

Meta Data​

To improve your API documentation's visibility on search engines, you can set the following fields:

Meta Title: The title of the webpage that will appear in search engine results.

Meta Description: A brief description of the webpage shown in search engine results.

Keywords: Target keywords for the webpage that enhance its search engine ranking.

Meta Social​

When sharing webpages on social media, you can enhance their appearance by customizing the card style with the following options. This feature is currently available for Twitter and Facebook.

Image: Select the image that will be displayed alongside your webpage on social media.

Title: Define the title that will appear when your webpage is shared on social media.

Description: Provide a brief description of your webpage that will be displayed on social media.

meta social

URL Rules​

On the API document publishing setting page, you can access theproject settingsto review the current URL rules.

click on project settings to view current url rules

After clicking, you will be directed to theURL Rulespage, where you can customize the relevant rules.

customize url rules

Note
  • 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.

As the system manages redirects automatically, the rules you set here will not appear in the "Publish Docs -> Publish -> Docs Redirect Rules" table.

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.

Docs Redirect Rules

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.

set up multiple redirect rules