We are excited to announce the latest addition to our Developer Portal: SEO-Friendly Features. These new features are designed to make your API documentation more discoverable by search engines, helping your users find the information they need quickly and efficiently.
This feature is only available in the portals created via Docs as Code workflow.
What is SEO?
"Search Engine Optimization" is the process of improving your website's visibility in search engine results, making it easier for your users to find your website, such as when they are searching for a feature or a query on a search engine like Google.
Search Engine Optimization can be divided into three essential parts:
- Search Crawler Support: Search engines must be able to discover all the pages and read their titles and content.
- On-Page SEO: Search engines must be able to understand the content, including any semantic information and associated metadata.
- Content SEO: Search engines must be able to find content that addresses the user's query.
What does APIMatic support?
APIMatic aims to provide both Search Crawler Support and On-Page SEO.
Our Search Crawler Support enables search engines to index your documentation pages and users to find them. This is the most critical aspect of SEO and requires support from both APIMatic and server-side.
Our On-Page SEO support is improving and will eventually allow the search engines to understand the content on the page, such as the paragraphs, headings, tables, and structured information (such as endpoints). If you find any room for improvement, please report them to our support.
More Details
Generating an SEO-friendly API Documentation Portal can be acheived by making a few changes to the Build file and support from the server-side. You can find the relevant documentation here to understand how to generate and host an SEO-friendly API Portal correctly.
This feature is off by default, and APIMatic will instead generate a Single-Page Application (SPA). SPAs are not SEO-friendly but more straightforward to deploy and less prone to deployment mistakes.