Swagger Petstore YAML
This is a sample server Petstore server.
You can find out more about Swagger at
http://swagger.io or on irc.freenode.net, #swagger.
For this sample, you can use the api key special-key to test the authorization filters.
Introduction
This API is documented in OpenAPI format and is based on Petstore sample provided by swagger.io team. It was extended to illustrate features of generator-openapi-repo tool and ReDoc documentation. In addition to standard OpenAPI syntax we use a few vendor extensions.
OpenAPI Specification
This API is documented in OpenAPI format and is based on Petstore sample provided by swagger.io team. It was extended to illustrate features of generator-openapi-repo tool and ReDoc documentation. In addition to standard OpenAPI syntax we use a few vendor extensions.
Cross-Origin Resource Sharing
This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec. And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
Authentication
Petstore offers two forms of authentication:
- API Key
- OAuth2 OAuth2 - an open protocol to allow secure authorization in a simple and standard method from web, mobile and desktop applications.
Authentication
- OAuth 2.0: petstore_auth
- API Key: api_key
Get access to data while protecting your account credentials. OAuth2 is also a safer and more secure way to give you access.
| Security Scheme Type: | oauth2 |
|---|---|
| OAuth Flow (implicit): | Authorization URL: http://petstore.swagger.io/api/oauth/dialog Scopes:
|
For this sample, you can use the api key special-key to test the authorization filters.
| Security Scheme Type: | apiKey |
|---|---|
| Header parameter name: | api_key |