The files describing the RESTful API in accordance with the Swagger specification are represented as JSON objects and conform to the JSON standards. The available status codes are described by RFC 7231 and in the IANA Status Code Registry. The HTTP Status Codes are used to indicate the status of the executed operation.
Some examples of possible mime type definitions: text/plain charset=utf-8 The mime type definitions should be in compliance with RFC 6838.
Mime type definitions are spread across several resources. Path templating refers to the usage of curly braces () to mark a section of a URL path as replaceable using path parameters. Revision History Versionįirst release of the Swagger Specification Additional utilities can also take advantage of the resulting files, such as testing tools. These files can then be used by the Swagger-UI project to display the API and Swagger-Codegen to generate clients in various languages. The Swagger specification defines a set of files required to describe such an API. Swagger™ is a project used to describe and document RESTful APIs. The Swagger specification is licensed under The Apache License, Version 2.0. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119. OpenAPI Specification (fka Swagger RESTful API Documentation Specification) Version 2.0
0 kommentar(er)
