What is Swagger
Swagger is an open specification for defining REST APIs.
A Swagger document is the REST API equivalent of a WSDL document for a SOAP-based web service. The Swagger document specifies the list of resources that are available in the REST API and the operations that can be called on those resources. The Swagger document also specifies the list of parameters to an operation, including the name and type of the parameters, whether the parameters are required or optional, and information about acceptable values for those parameters. Additionally, the Swagger document can include JSON Schema that describes the structure of the request body that is sent to an operation in a REST API, and the JSON schema describes the structure of any response bodies that are returned from an operation.
Swagger support for HATS RESTful services
IBM HATS V9.6 supports version 2.0 of the Swagger specification. For information about Swagger, see Swagger. For information about version 2.0 of the Swagger specification, see Swagger RESTful API Documentation Specification Version 2.0.
IBM HATS uses bottom-up approach where you have the REST API for which you want to automatically create a Swagger definition by adding the annotations.
HATS toolkit’s REST API create/update interfaces allows you to easily enable or disable swagger documentation for each service. However, the REST API editor does not support the full Swagger specification, and cannot be used to set some properties, such as validation attributes, on objects in the Swagger document.
Benefits of HATS REST API Swagger document
This industry-standard Open API(Swagger) description allows easy consumption of HATS RESTful services by both developers and API management solutions. A range of third-party tools are available for you to use with Swagger documents.
This enables and encourages easy participation of HATS RESTful services in API Economy.
Improve consumption of your OpenAPI-defined APIs in every popular language with tools like Swagger Codegen and IBM Rational Application Developer WebSphere Developer Tools. Usage of these tools can simplify your build process by generating server stubs and/or client SDKs from your OpenAPI specification, so your team can focus better on your API’s implementation and adoption.
Fig: Example third-party tools or API Management solutions available to use with Swagger documents
All about Swagger
Generate client/server stub using Swagger Codegen
Generating a JAX-RS 2.0 client from a REST API definition file
Chief Architect, HATS