d00markdown

title: Swagger Petstore version: 1.0.0

Swagger Petstore

A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification

• paths
• schemas

paths

main.FindPets GET /pets

Returns all pets

input (application/json)

// GET /pets
type Input struct {
	// tags to filter by
	tags? []string `in:"query"`

	// maximum number of results to return
	limit? integer `in:"query"`
}

output (application/json)

// GET /pets (200)
// pet response
type Output200 []struct {	// Pet
	// Unique id of the pet
	id integer `format:"int64"`

	// Name of the pet
	name string

	// Type of the pet
	tag? string
}

// GET /pets (default)
// default error
type OutputDefault struct {	// Error
	// Error code
	code integer `format:"int32"`

	// Error message
	message string
}

examples

// GET /pets (200)
// sample output
[
  {
    "id": 1,
    "name": "foo",
    "tag": "A"
  },
  {
    "id": 2,
    "name": "bar",
    "tag": "A"
  },
  {
    "id": 3,
    "name": "boo",
    "tag": "B"
  }
]

// GET /pets (default)

{
  "code": 444,
  "message": "unexpected error!"
}

description

Returns all pets from the system that the user has access to Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.

Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.

main.AddPet POST /pets

Creates a new pet

input (application/json)

// POST /pets
type Input struct {
	// Pet to add to the store
	JSONBody struct {	// AddPetInput
		// Name of the pet
		name string

		// Type of the pet
		tag? string
	}
}

output (application/json)

// POST /pets (200)
// pet response
type Output200 struct {	// Pet
	// Unique id of the pet
	id integer `format:"int64"`

	// Name of the pet
	name string

	// Type of the pet
	tag? string
}

// POST /pets (default)
// default error
type OutputDefault struct {	// Error
	// Error code
	code integer `format:"int32"`

	// Error message
	message string
}

examples

// POST /pets (default)

{
  "code": 444,
  "message": "unexpected error!"
}

description

Creates a new pet in the store. Duplicates are allowed

main.DeletePet DELETE /pets/{id}

Deletes a pet by ID

input (application/json)

// DELETE /pets/{id}
type Input struct {
	// ID of pet to delete
	id integer `in:"path"`
}

output (application/json)

// DELETE /pets/{id} (204)
// pet deleted
type Output204 struct {	// 
}

// DELETE /pets/{id} (default)
// default error
type OutputDefault struct {	// Error
	// Error code
	code integer `format:"int32"`

	// Error message
	message string
}

examples

// DELETE /pets/{id} (default)

{
  "code": 444,
  "message": "unexpected error!"
}

description

deletes a single pet based on the ID supplied

main.FindPetByID GET /pets/{id}

Returns a pet by ID

input (application/json)

// GET /pets/{id}
type Input struct {
	// ID of pet to fetch
	id integer `in:"path"`
}

output (application/json)

// GET /pets/{id} (200)
// pet response
type Output200 struct {	// Pet
	// Unique id of the pet
	id integer `format:"int64"`

	// Name of the pet
	name string

	// Type of the pet
	tag? string
}

// GET /pets/{id} (default)
// default error
type OutputDefault struct {	// Error
	// Error code
	code integer `format:"int32"`

	// Error message
	message string
}

examples

// GET /pets/{id} (default)

{
  "code": 444,
  "message": "unexpected error!"
}

description

Returns a pet based on a single ID

schemas

AddPetInput

type AddPetInput struct {
	// Name of the pet
	name string

	// Type of the pet
	tag? string
}

• input of main.AddPet as AddPetInput

Error

type Error struct {
	// Error code
	code integer `format:"int32"`

	// Error message
	message string
}

exmaples

// 
{
  "code": 444,
  "message": "unexpected error!"
}

• output of main.FindPets (default) as Error
• output of main.AddPet (default) as Error
• output of main.DeletePet (default) as Error
• output of main.FindPetByID (default) as Error

Pet

pet object.

// Pet : pet object.
type Pet struct {
	// Unique id of the pet
	id integer `format:"int64"`

	// Name of the pet
	name string

	// Type of the pet
	tag? string
}

• output of main.FindPets (200) as []Pet
• output of main.AddPet (200) as Pet
• output of main.FindPetByID (200) as Pet