Sharing API Documentation

Once your API is developed and successfully debugged, Apidog makes it easy to generate professional documentation that you can share with your team, stakeholders, or external developers.

Step-by-Step Guide

Follow these steps to generate and share your API documentation:

Open your Apidog project

Switch to the Share Docs module from the sidebar

📷 Visual Reference

Click the New button to initiate a new documentation share

This will open the share configuration dialog

Complete the following settings in the share configuration:

Setting	Description	Recommended Action
Name	Give your share a descriptive name	Use project name + version (e.g., "Pet Store API v1.2")
Environments	Select which environments to include	Select all environments for comprehensive documentation
Access	Set visibility permissions	Choose appropriate access level for your audience

📷 Visual Reference

Click Save to create your share

Step 4: Access Your Documentation

Your new share will appear in the shares list

Click Open to view your documentation in a web browser

The documentation will open in a new tab with a shareable URL

Step 5: Explore Documentation Features

Your documentation includes powerful features:

Interactive API Explorer: Navigate endpoints in the left directory tree

Try It Out: Send live requests directly from documentation

Code Generation: Generate request code snippets and data model code

Environment Switching: Test different API environments

📷 Visual Reference

Advanced Customization and Publishing

Apidog offers additional customization for your documentation:

Feature	Description	Use Case
Custom Layout	Modify documentation structure and appearance	Brand consistency, user experience optimization
Custom Domain	Use your own domain name	Professional presentation, brand recognition
Custom URLs	Create memorable, meaningful URLs	Marketing, easy sharing, SEO benefits
Access Control	Set granular permissions	Internal teams, external partners, public access

For detailed information about advanced publishing options, refer to the Publish API documentation guide.

Explore More

Learn more about designing, testing, mocking and publishing APIs in Apidog.

Sharing API Documentation

Step-by-Step Guide#

Step 1: Access the Share Docs Module#

Step 2: Create a New Share#

Step 3: Configure Share Settings#

Step 4: Access Your Documentation#

Step 5: Explore Documentation Features#

Advanced Customization and Publishing#

Step-by-Step Guide

Step 1: Access the Share Docs Module

Step 2: Create a New Share

Step 3: Configure Share Settings

Step 4: Access Your Documentation

Step 5: Explore Documentation Features

Advanced Customization and Publishing