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

Create a new schema

Add a new schema#

1
In the APIs module, click on the ➕ icon and select New Schema to create a new schema.
2
Fill in the name and description of the schema.
3
Build the structure of the schema in the Schema Editor.

Manage Schemas#

In the Schemas section of the APIs module, you can manage all schemas within the project—create new ones, rename, delete, and reorder them.
You can organize schemas by creating folders for better structuring and organization.
You can also create new schemas by importing from database tables or JSON schema files. Learn more about Generate Schemas from JSON etc..
Modified at 2025-03-24 11:30:40
Previous
Overview
Next
Build a schema
Built with