Package io.vertigo.vega.impl.webservice.catalog

Class SwaggerWebServices

java.lang.Object

io.vertigo.vega.impl.webservice.catalog.SwaggerWebServices

All Implemented Interfaces:

io.vertigo.core.node.component.Component, io.vertigo.core.node.component.CoreComponent, WebServices

public final class SwaggerWebServices
extends Object
implements WebServices

Swagger WebService to list services published.

Author:

npiedeloup (22 juil. 2014 11:12:02)

See Also:

• "https://github.com/wordnik/swagger-spec/blob/master/versions/2.0.md"

Constructor Summary

Constructors

Constructor	Description
SwaggerWebServices()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getSwapperApi(jakarta.servlet.http.HttpServletRequest request)
void	getSwapperUi(jakarta.servlet.http.HttpServletResponse response)	Redirect to index.html.
void	getSwapperUi(String resourceUrl, jakarta.servlet.http.HttpServletResponse response)	Return a swagger static resources.
void	getSwapperUi(String resourcePathUrl, String resourceUrl, jakarta.servlet.http.HttpServletResponse response)	Return a swagger static resources.
void	getSwapperUiEmpty(jakarta.servlet.http.HttpServletResponse response)	Redirect to index.html.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SwaggerWebServices

public SwaggerWebServices()

Method Details

getSwapperApi

@SessionLess
@AnonymousAccessAllowed
@GET("/swaggerApi")
public Map<String,Object> getSwapperApi(jakarta.servlet.http.HttpServletRequest request)

Parameters:

request - HttpRequest

Returns:

Api representation in Swagger definition

getSwapperUi

@SessionLess
@AnonymousAccessAllowed
@GET("/swaggerUi")
public void getSwapperUi(jakarta.servlet.http.HttpServletResponse response)
                  throws IOException

Redirect to index.html.

Parameters:

response - HttpResponse

Throws:

IOException - Exception

getSwapperUiEmpty

@SessionLess
@AnonymousAccessAllowed
@GET("/swaggerUi/")
public void getSwapperUiEmpty(jakarta.servlet.http.HttpServletResponse response)
                       throws IOException

Redirect to index.html.

Parameters:

response - HttpResponse

Throws:

IOException - Exception

getSwapperUi

@SessionLess
@AnonymousAccessAllowed
@GET("/swaggerUi/{resourceUrl}")
public void getSwapperUi(@PathParam("resourceUrl")
 String resourceUrl,
 jakarta.servlet.http.HttpServletResponse response)
                  throws IOException

Return a swagger static resources.

Parameters:

resourceUrl - Resource name

response - HttpResponse

Throws:

IOException - Exception

getSwapperUi

@SessionLess
@AnonymousAccessAllowed
@GET("/swaggerUi/{resourcePathUrl}/{resourceUrl}")
public void getSwapperUi(@PathParam("resourcePathUrl")
 String resourcePathUrl,
 @PathParam("resourceUrl")
 String resourceUrl,
 jakarta.servlet.http.HttpServletResponse response)
                  throws IOException

Return a swagger static resources.

Parameters:

resourcePathUrl - Resource path

resourceUrl - Resource name

response - HttpResponse

Throws:

IOException - Exception