Apidog Docs
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
  1. Publish API Docs
  • Apidog Learning Center
  • Get started
    • Introduce Apidog
    • Basic concepts in Apidog
    • Navigating Apidog
    • Quick Start
      • Overview
      • Specify a new endpoint
      • Make a request to the endpoint
      • Add an assertion
      • Create a test scenario
      • Share your API documentation
      • Explore more
      • Send a request and save as an endpoint
    • Migration
      • Overview
      • Manual import
      • Scheduled import
      • Import options
      • Export data
      • Import from...
        • Import from Postman
        • Import OpenAPI (Swagger) spec
        • Import cURL
        • Import Markdowns
        • Import from Insomnia
        • Import from apiDoc
        • Import .har file
        • Import WSDL
  • Design APIs
    • Overview
    • Create a new API project
    • Endpoint basics
    • Components
    • Common fields
    • Global parameters
    • Endpoint change history
    • Batch endpoint management
    • Configure multiple request body examples
    • Schemas
      • Generate Schemas from JSON etc.
      • Build a schema
      • Overview
      • Create a new schema
    • Security schemes
      • Overview
      • Create a security scheme
      • Use the security scheme
      • Security scheme in online documentation
    • Advanced features
      • Custom endpoint fields
      • Import endpoints as test steps
      • Endpoint status
      • Appearance of parameter lists
      • Endpoint unique idenfication
  • Develop and Debug APIs
    • Overview
    • Generate requests
    • Send requests
    • Endpoint cases
    • Dynamic values
    • Validate responses
    • Design-first Mode & Request-first Mode
    • Generate code
    • Environments & variables
      • Overview
      • Using variables
      • Environments & services
    • Vault secrets
      • Overview
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • Pre/Post processors
      • Overview
      • Assertion
      • Extract variable
      • Wait
      • Database operations
        • Overview
        • MongoDB
        • Redis
        • Oracle Client
      • Using scripts
        • Overview
        • Postman scripts reference
        • Pre processor scripts
        • Post processor scripts
        • Public scripts
        • Calling other programming languages
        • Using JS libraries
        • Visualizing responses
        • Script examples
          • Assertion scripts
          • Using variables in scripts
          • Using scripts to modify request messages
          • Other examples
    • Dynamic values Modules
  • Mock API data
    • Overview
    • Smart mock
    • Custom mock
    • Mock priority sequence
    • Mock scripts
    • Cloud mock
    • Self-hosted runner mock
    • Mock language (Locales)
  • Automated tests
    • Overview
    • Test reports
    • Test scenarios
      • Create a test scenario
      • Pass data between requests
      • Flow control conditions
      • Import endpoints/endpoint cases from other projects
      • Sync data from endpoints/endpoint cases
      • Export test scenarios
    • Run test scenarios
      • Run a test scenario
      • Data-driven testing
      • Run test scenarios in batch
      • Scheduled tasks
      • Manage the runtime environment of APIs from other projects
    • Test APIs
      • Integration testing
      • Performance testing
      • End-to-end testing
      • Regression testing
    • Apidog CLI
      • Overview
      • Installing and running Apidog CLI
      • Apidog CLI Options
    • CI/CD
      • Overview
      • Integrate with Jenkins
      • Integration with Gitlab
  • Publish API Docs
    • Overview
    • API Technologies Supported
    • Quick share
    • View the API documentation
    • Publish docs sites
    • Folder tree settings
    • Custom layouts
    • Visibility settings
    • Endpoint SEO settings
    • Custom domain
    • Embedding values in document URLs
    • Documentation Search
    • Integrating Google Analytics with Doc Sites
    • CORS Proxy
    • API Versions
      • Overview
      • Create API versions
      • Publish API versions
      • Share endpoints with API versions
  • Send requests
    • Overview
    • gRPC
    • Use request proxy agents for debugging
    • SOAP/WebService
    • GraphQL
    • WebSocket
    • Socket.IO
    • SSE debugging
    • Create requests
      • Request History
      • Request basics
      • Parameters and body
      • Request headers
      • Request settings
      • HTTP/2
    • Authentication and authorization
      • Overview
      • CA and client certificates
      • Authorization types supported by Apidog
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • Response and cookies
      • Overview
      • API response in Apidog
      • Create and send cookies
      • Debug requests
      • Save the request as an endpoint
  • Branches
    • Overview
    • Create a new sprint branch
    • Test APIs in a branch
    • Design API in a branch
    • Merge sprint branches
    • Manage sprint branches
  • Apidog MCP Server
    • Overview
    • Conntect API Specification within Apidog Project to AI via Apidog MCP Server
    • Conntect Online API Documentation Published by Apidog to AI via Apidog MCP Server
    • Conntect OpenAPI Files to AI via Apidog MCP Server
  • Best practices
    • How to handle API signatures
    • How to access OAuth 2.0 protected APIs
    • Apidog collaboration workflow
    • Managing authentication state in Apidog
  • Administration
    • Onboarding Checklist
      • Basic Concepts
      • Onboarding Guide
    • Managing Teams
      • Managing Teams
      • Managing Team Members
      • Member Roles & Permission Settings
      • Team Activities
      • Team Resources
        • General Runner
        • Team Variables
        • Request Proxy Agent
      • Real-time Collaborations
        • Team Collaboration
    • Managing Projects
      • Managing Projects
      • Managing Project Members
      • Notification Settings
      • Project Resources
        • Database Connection
    • Managing Organizations
      • Single Sign-On (SSO)
        • SSO Overview
        • Configure Microsoft Entra ID
        • Configure Okta
        • Configure SSO for an Organization
        • Managing user accounts
        • Mapping Groups to Teams
      • SCIM Provisioning
        • Intro to SCIM Provisioning
        • Microsoft Entra ID
        • Okta
      • Organization Resources
        • Self-hosted Runner
  • Billing
    • Overview
    • Credits
    • Unable to use credit cards?
    • Managing subscriptions
    • Upgrade plan
  • Add-ons
    • API Hub
    • Apidog Intellij IDEA plugin
    • Browser Extension
      • Chrome
      • Microsoft Edge
    • Request Proxy
      • Request proxy in Apidog web
      • Request proxy in shared docs
      • Request proxy in Apidog client
  • Account & preferences
    • Language settings
    • Data backup
    • Network proxy configuration
    • Hot keys
    • Updating Apidog
    • Generate OpenAPI access token
    • Deleting account
    • Account settings
  • References
    • API-Design First Approach
    • Apidog OpenAPI/Swagger Specificaiton Extensions
    • JSONPath
    • XPath
    • Regular Expressions
    • JSON Schema
    • CSV File Format
    • Install Java Environment
    • Runner deployment environment
    • Apidog flavored Markdown
  • Apidog Europe
    • Apidog Europe
  • Support Center
  1. Publish API Docs

Quick share

In API development, communication, and collaboration, API documentation is logically the standard, but in practice, there is the problem of passing around files in Word or PDF formats. For this reason, online document is advocated to improve the efficiency of communication between teams.

Create a quick share#

Switch to Share Docs module on the left side.
sharing-01.png
Click+Newto create a new Quick share. A project supports multiple different Quick shares, which can be distributed to different collaborators. Every team member can see all Quick shares created by everyone.
create-documentation-share.jpg
In the New Share popup, you can customize the following options:
Title: The name of this share, only visible within the Apidog team, used for internal identification, not visible in the shared documentation.
Environments: Choose the environments available in the online document. By default, no environment is selected. You can select multiple environments. The selected environments will be visible to readers in the documentation and can be used to send requests when using "Try it out".
If you select the Cloud mock environment when creating the documentation, it's equivalent to enabling a simple sandbox environment for the readers of the documentation.
Document content: The document has two optional components: Base URL and Request samples. You can choose whether to display them in the document.
Base URL: This is the base URL set in the environment. If selected, each interface in the document will show the complete URL; if not selected, the URL in the document will start with "/".
Owners: Show oweners of this API documentation.
Request samples: Whether to display example code for calling requests. See request samples for details.
Show 'Last Modified' time above endpoint description.
Show 'Last Modified' time at the end of the documentation.
Allow 'Export', 'Clone' Data: Whether to allow readers to export & clone data in OAS/Markdown/HTML/Apidog format.
Scope to share: Choose which API endpoints and Markdown to include in this share. You can select by directory or filter and exclude by tag. You can also choose to share the entire folder.
Security: You can set whether a password is required to access this document, and the expiration time of this document. If no expiration time is selected, it never expires.
Show API Fields: You can set whether these fields are displayed in the document. Including: Owners, Update time, OperationId, Original link, Authorization Required.
Language: The language setting here will affect the functional fixed text in the document, such as "Query Params" "Request samples", etc., but will not affect the text written in the API documentation content.
CORS Proxy: You can deploy and configure the CORS proxy server to handle endpoint requests on API documentation. Learn more.
Advanced settings: You can set Hide 'Try it out' Button and Hide 'Powered by Apidog' here.

Request samples#

You can choose whether to display this module when creating the share.
You can customize Request samples. Here's how:
1.
In Project settings - Feature settings - Endpoint feature settings - Endpoint fields, enable the Request samples field.
2.
Then in Endpoint - Edit, a Request samples module will appear at the end.
3.
You can click Add request sample here to add samples in the languages you need. Then it will appear in the documentation.
image.png

Share the entire folder#

Quick share supportsShare entire folder. This is suitable for scenarios where, after sharing the link, you may have added or removed documents in the folder, and you want collaborators to be able to see these changes synchronously.
In the Scope to Share, when you select Manual Selection, you can see Share entire folder. When enabled, collaborators will automatically have access to all documentations in the folder, so you won’t need to adjust the sharing settings each time you add new documents.
sharing-03.png

CORS Proxy#

When sharing API documentation online with external users, they may want to test or debug endpoints directly within the documentation. However, this can trigger cross-origin resource sharing (CORS) issues in the browser, blocking their requests. To fix this, you can set up a CORS proxy. This proxy routes all endpoint requests from the shared documentation through a designated request proxy agent, effectively bypassing CORS restrictions and allowing seamless debugging.
To set up the CORS proxy, simply click on the setting option when creating a new shared documentation. By default, Apidog offersCloud Agentto manage endpoint requests across all shared documentations.
configuring-cors-proxy.jpg
Select the CORS proxy option best suited to your needs:
choose-desired-cors-proxy.jpg
Cloud Agent: This uses Apidog'sCloud Agentto handle endpoint requests from the shared documentation. Keep in mind that the Cloud Agent cannot access endpoints on internal network.
Browser Extensions: This option uses a browser extension installed in the user's browser to handle requests. If the user hasn't installed the extension, they'll be prompted to do so before initiating any endpoint requests.
No Proxy: Selecting this option means that requests will be directly sent from the user's browser to the endpoint. Ensure the endpoint server settings are configured correctly to handle CORS, preventing potential issues.
Self-hosted Request Proxy Agent: This allows you to use a Self-hosted Request Proxy Agent deployed within your team to handle endpoint requests from the shared documentation.

Share the link#

After the setting is complete, copy the link to share with team members.
See how to View the API documentation.
Modified atΒ 2025-01-15 09:50:42
Previous
API Technologies Supported
Next
View the API documentation
Built with