DOCSEARCHbyAlgolia
Submit Docs

Apidog Documentation

website·Indexed 34 days ago

https://o2luk2cvgc.apidog.io

API documentation and guides for Apidog, featuring getting started instructions and OpenAPI Specification examples for managing pets, categories, and tags.

Tokens
2.4K
Snippets
11
Records
21
Agent score
48%

What's inside Apidog

  1. Overview of Apidog core capabilities

    Apidog is an integrated API platform that provides the following core capabilities:

    • API Design: Visual editor with JSON Schema support for OAS design and endpoint change history.
    • API Debugging: Request execution with auto-validation of responses, support for Postman scripts, and database connectivity.
    • API Testing: Test scenario design with support for looping, branching, scheduled tasks, and performance testing.
    • API Mocking: Automatic mock data generation (cloud-based) and custom response expectations for frontend development.
    • API Documentation: One-click generation of API docs with support for mixing Markdown and custom domains.
    • Collaboration: Sprint branches for team collaboration, including branch creation, testing, and merging.

  3. Retrieve a pet by its ID

    Use the GET /pet/{petId} endpoint to retrieve detailed information about a specific pet. The request requires a petId as a path parameter.

    Responses:

    • 200 OK: Returns a JSON object containing a status code and a data object with the pet's details (including name, photo URLs, category, tags, and sales status).
    • 400 Invalid input: Returned when the request is malformed.
    • 404 Record not found: Returned when no pet exists with the provided ID.
    curl -X GET "https://<server-url>/pet/1"

  5. Use Apidog Europe for GDPR compliance

    Apidog Europe is available for users who need their data stored within Europe to ensure compliance with GDPR regulations. This includes a specific download for the EU version and a process to migrate data from Apidog Global to Apidog Europe.

  8. Authenticate requests to the Apiary API

    The Apiary API supports two primary methods of authentication: Bearer Token Authorization and Basic Authentication. Bearer tokens can be managed via the tokens page or programmatically created, retrieved, or deleted using Basic Authentication. When accessing protected resources, include the token in the Authorization header.
    # Using a Bearer Token
Authorization: Bearer 874887d6ecd0b106a47448c5beca1...

# Using Basic Authentication
Authorization: Basic dGVzdEB0ZXN0LnRlc3Q6dGVzdHRlc3Q=

  9. Pet object schema for updates

    The Pet object used in the /pet update endpoint requires the following properties:

    • id (integer, int64): The unique ID of the pet (minimum: 1).
    • category (object): Must contain id (integer) and name (string).
    • name (string): The name of the pet.
    • photoUrls (array of strings): A list of image URLs.
    • tags (array of objects): A list of tags, each containing an id (integer) and name (string).
    • status (string): The sales status of the pet. Must be one of: available, pending, or sold.

  10. Define the Tag object schema in OpenAPI Specification

    The Tag object is defined as a schema within the OpenAPI components. It consists of a unique integer identifier and a string name. The id property must be a positive integer (minimum 1).
    components:
  schemas:
    Tag:
      type: object
      properties:
        id:
          type: integer
          format: int64
          minimum: 1
          description: Tag ID
        name:
          type: string
          description: Tag Name

  11. Pet object schema

    The Pet object represents a pet in the system and contains the following properties:

    • id (integer, int64): Unique Pet ID (minimum 1).
    • category (object): The category group containing id and name.
    • name (string): The name of the pet.
    • photoUrls (array of strings): A list of image URLs.
    • tags (array of objects): A list of tags, each containing an id and name.
    • status (string): The sales status. Must be one of: available, pending, or sold.

  12. Category data model schema

    The Category object is defined as a schema with two primary properties: id (a 64-bit integer, minimum value of 1) and name (a string).
    Category:
  type: object
  properties:
    id:
      type: integer
      format: int64
      minimum: 1
      description: Category ID
    name:
      type: string
      description: Category Name