Configuring the Swagger definition

After specifying the Swagger provider components, the next step is to configure and initialize the Swagger definition. This is done by configuring the com.wordnik.swagger.jersey.config.JerseyJaxrsConfig servlet in web.xml, as follows:

<servlet> 
    <servlet-name>Jersey2Config</servlet-name> 
    <servlet-class> 
        com.wordnik.swagger.jersey.config.JerseyJaxrsConfig 
    </servlet-class> 
    <init-param> 
        <param-name>api.version</param-name> 
        <param-value>1.0.0</param-value> 
    </init-param> 
    <init-param> 
        <param-name>swagger.api.basepath</param-name> 
        <param-value> 
            http://localhost:8080/hrapp/webresources 
        </param-value> 
    </init-param> 
    <load-on-startup>1</load-on-startup> 
</servlet> 

Here is a brief overview of the initialization parameters used for JerseyJaxrsConfig:

  • api.version: This parameter specifies the API version for your application
  • swagger.api.basepath: This parameter specifies the base path for your application

With this step, we have finished all the configuration entries for using Swagger in a JAX-RS (Jersey 2 implementation) application. In the next section, we will see how to use the Swagger metadata annotation on a JAX-RS resource class for describing the resources and operations.

..................Content has been hidden....................

You can't read the all page of ebook, please click here login for view all page.
Reset
3.129.218.45