> For the complete documentation index, see [llms.txt](https://xiaoxiami.gitbook.io/swagger/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://xiaoxiami.gitbook.io/swagger/swagger-php-wen-dang/swaggerde-jiang-jieff08-explained.md).

# Swagger 的讲解（Explained）

> 原文：[Swagger Explained](http://bfanger.github.io/swagger-explained/)\
> 翻译：小虾米（QQ:509129）

## Swagger 的讲解（Explained）

```javascript
{
  "swagger": "2.0", 
  "info": {
    "version": "1.0.0", 
    "title": "Swagger Petstore", 
    "description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", 
    "termsOfService": "http://swagger.io/terms/", 
    "contact": {
      "name": "Swagger API Team"
    }, 
    "license": {
      "name": "MIT"
    }
  }, 
  "host": "petstore.swagger.io", 
  "basePath": "/api", 
  "schemes": [
    "http"
  ], 
  "consumes": [
    "application/json"
  ], 
  "produces": [
    "application/json"
  ], 
  "paths": {
    "/pets": {
      "get": {
        "description": "Returns all pets from the system that the user has access to", 
        "operationId": "findPets", 
        "produces": [
          "application/json", 
          "application/xml", 
          "text/xml", 
          "text/html"
        ], 
        "parameters": [
          {
            "name": "tags", 
            "in": "query", 
            "description": "tags to filter by", 
            "required": false, 
            "type": "array", 
            "items": {
              "type": "string"
            }, 
            "collectionFormat": "csv"
          }, 
          {
            "name": "limit", 
            "in": "query", 
            "description": "maximum number of results to return", 
            "required": false, 
            "type": "integer", 
            "format": "int32"
          }
        ], 
        "responses": {
          "200": {
            "description": "pet response", 
            "schema": {
              "type": "array", 
              "items": {
                "$ref": "#/definitions/Pet"
              }
            }
          }, 
          "default": {
            "description": "unexpected error", 
            "schema": {
              "$ref": "#/definitions/ErrorModel"
            }
          }
        }
      }, 
      "post": {
        "description": "Creates a new pet in the store. Duplicates are allowed", 
        "operationId": "addPet", 
        "produces": [
          "application/json"
        ], 
        "parameters": [
          {
            "name": "pet", 
            "in": "body", 
            "description": "Pet to add to the store", 
            "required": true, 
            "schema": {
              "$ref": "#/definitions/NewPet"
            }
          }
        ], 
        "responses": {
          "200": {
            "description": "pet response", 
            "schema": {
              "$ref": "#/definitions/Pet"
            }
          }, 
          "default": {
            "description": "unexpected error", 
            "schema": {
              "$ref": "#/definitions/ErrorModel"
            }
          }
        }
      }
    }, 
    "/pets/{id}": {
      "get": {
        "description": "Returns a user based on a single ID, if the user does not have access to the pet", 
        "operationId": "findPetById", 
        "produces": [
          "application/json", 
          "application/xml", 
          "text/xml", 
          "text/html"
        ], 
        "parameters": [
          {
            "name": "id", 
            "in": "path", 
            "description": "ID of pet to fetch", 
            "required": true, 
            "type": "integer", 
            "format": "int64"
          }
        ], 
        "responses": {
          "200": {
            "description": "pet response", 
            "schema": {
              "$ref": "#/definitions/Pet"
            }
          }, 
          "default": {
            "description": "unexpected error", 
            "schema": {
              "$ref": "#/definitions/ErrorModel"
            }
          }
        }
      }, 
      "delete": {
        "description": "deletes a single pet based on the ID supplied", 
        "operationId": "deletePet", 
        "parameters": [
          {
            "name": "id", 
            "in": "path", 
            "description": "ID of pet to delete", 
            "required": true, 
            "type": "integer", 
            "format": "int64"
          }
        ], 
        "responses": {
          "204": {
            "description": "pet deleted"
          }, 
          "default": {
            "description": "unexpected error", 
            "schema": {
              "$ref": "#/definitions/ErrorModel"
            }
          }
        }
      }
    }
  }, 
  "definitions": {
    "Pet": {
      "type": "object", 
      "allOf": [
        {
          "$ref": "#/definitions/NewPet"
        }, 
        {
          "required": [
            "id"
          ], 
          "properties": {
            "id": {
              "type": "integer", 
              "format": "int64"
            }
          }
        }
      ]
    }, 
    "NewPet": {
      "type": "object", 
      "required": [
        "name"
      ], 
      "properties": {
        "name": {
          "type": "string"
        }, 
        "tag": {
          "type": "string"
        }
      }
    }, 
    "ErrorModel": {
      "type": "object", 
      "required": [
        "code", 
        "message"
      ], 
      "properties": {
        "code": {
          "type": "integer", 
          "format": "int32"
        }, 
        "message": {
          "type": "string"
        }
      }
    }
  }
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://xiaoxiami.gitbook.io/swagger/swagger-php-wen-dang/swaggerde-jiang-jieff08-explained.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.