Skip to content

Instantly share code, notes, and snippets.

@jerzyn
Created July 1, 2015 15:16
Show Gist options
  • Save jerzyn/869e9e0babc544a72819 to your computer and use it in GitHub Desktop.
Save jerzyn/869e9e0babc544a72819 to your computer and use it in GitHub Desktop.
Info Object Specification
{
// REQUIRED FIELDS
"title": "Swagger Petstore",
"version": "1.0.0",
// OPTIONAL FIELDS COVERED BY THIS EXAMPLE
"description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification",
// A short description of the application. GFM (Github Flavoured Markdown: https://help.github.com/articles/github-flavored-markdown/) syntax can be used for rich text representation.
"termsOfService": "http://swagger.io/terms/",
// The Terms of Service for the API. Link or any String.
"contact": {
"name": "Swagger API Team",
// The identifying name of the contact person/organization.
"email": "foo@example.com",
// The URL pointing to the contact information. MUST be in the format of a URL.
"url": "http://madskristensen.net"
// The email address of the contact person/organization. MUST be in the format of an email address.
},
"license": {
"name": "MIT",
// Required. The license name used for the API.
"url": "http://github.com/gruntjs/grunt/blob/master/LICENSE-MIT"
// A URL to the license used for the API. MUST be in the format of a URL.
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment