Build API Docs with Apidog
  1. Advanced features
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. Advanced features

Custom endpoint fields

When collaborating on APIs, there may be a need for some custom additional fields to describe endpoints. For example, you could add fields such as "Authorization Required," "Response Format," or "Rate Limiting Policy" to provide more context to users consuming the API.
In Apidog, you can leverage Customized Fields to implement these additional fields seamlessly.

Configure custome fields#

You can set up endpoint fields in Apidog by navigating to Settings > General Settings > Feature Settings > Endpoint Feature Settings. The customized fields that you configure here will apply project-wide in Apidog.
Apidog provides three default built-in fields that you can manually enable or disable. If enabled, the field will appear in the endpoint metadata.

Add new field#

You also have the flexibility to add your custom fields as needed.
The field type in Apidog supports the following types: Text, Number, Single select, Multiple select, Date, Team member, Link, Email, Single label, and Multiple label.

Show fields in API documentation#

In Quick Share, you have the option to choose whether to display these custom fields.
1
When creating a Quick Share in Apidog, you can select the option "Show API Fields" to include the API fields you defined.
2
Select fields to be displayed.
3
They will be displayed in the documentation.
When publishing documentation in Apidog, you can also choose which fields to display. In the Share Docs section, under Publish Docs > Basic Settings > Content Display, you have the option to select fields.
Modified at 2025-03-24 11:30:40
Previous
Generate Schemas from JSON etc.
Next
Endpoint status
Built with