Build API Docs with Apidog
  1. Example: Pet Store
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
        GET
      • Find pet by ID
        GET
      • Add a new pet to the store
        POST
      • Update an existing pet
        PUT
      • Deletes a pet
        DELETE
      • Finds Pets by status
        GET
  • 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. Example: Pet Store

Deletes a pet

DELETE
/pet/{petId}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request DELETE '/pet/' \
--header 'api_key;'
Response Response Example
{
    "code": 0
}

Request

Path Params
petId
string 
required
Pet id to delete
Header Params
api_key
string 
optional

Responses

🟢200OK
application/json
Body
code
integer 
required
>= 0<= 0
Modified at 2025-03-24 11:28:35
Previous
Update an existing pet
Next
Finds Pets by status
Built with