Build API Docs with Apidog
  1. Basics
Build API Docs with Apidog
  • Overview
  • REST API Documentations
    • Basics
      • API-Design First Approach
      • Specify an endpoint
      • Components
      • Common parameters
      • Global parameters
      • Schemas
        • Overview
        • Create a new schema
        • Build a schema
        • Generate Schemas from JSON etc.
    • Advanced features
      • Custom endpoint fields
      • Endpoint status
      • Appearance of parameter lists
      • Endpoint unique idenfication
    • Example: Pet Store
      • Get user info
      • Find pet by ID
      • Add a new pet to the store
      • Update an existing pet
      • Deletes a pet
      • Finds Pets by status
  • SOAP API Documentations
    • How to Use Apidog to Write SOAP API Documentation
    • Example: WebService
      • WebService: Number To Words
      • SOAP: Add integers
      • SOAP/WSDL: Ebay
    • Example: Mastercard
      • Purchase Request
      • Submit a purchase request
  • GraphQL Documentation
    • How to Write GraphQL API Documentation Using Apidog
    • Example: Github
      • Introduction to GraphQL
      • Queries
      • Public schema
  • WebSocket Documentations
    • How to Use Apidog to Write WebSocket API Documentation
    • Example: Coinbase
      • Overview
      • Channel
  • SSE API Documentations
    • Example: Anthropic
      • Streaming Messages
      • Messages
  • gRPC API Documentations
    • How to Use Apidog for gRPC API Documentation and Testing
    • Example: Proto Documentation
      • Protocol Documentation
  1. Basics

Common parameters

In API development, maintaining consistency across endpoints is critical. Apidog addresses this by offering the Common Parameters feature, which allows for the reuse of parameters with identical names and descriptions across different endpoints.

Configure common parameters#

To modify or set up your common parameters, follow these steps:
1
Access Parameter Settings
Click on the menu button located on the Description section within the endpoint spec interface.
Alternatively, you can manage common parameters under Settings - Project Resources - Common Parameters.
2
Enter Details
Type in the parameter name, description, and any other necessary information.
3
Save the Parameter
Confirm your entries by clicking on the "Save" button.

Import / Bulk Edit#

Supports importing or bulk editing commonly used parameters using either comma or colon as separators.

Utilizing Common Parameters#

When entering parameter names in an endpoint, you will be presented with pre-defined Common Parameters for selection. Choosing a Common Parameter will automatically populate its Description.
Modified at 2025-03-24 11:36:04
Previous
Components
Next
Global parameters
Built with