Skip to content

Parameter Description not showing in swagger-ui #604

@frankgibbs

Description

@frankgibbs

Below is my annotation, I'm under the assumption the ApiImplicitParams "value" parameter should show as parameter description in swagger-ui, but it's not. Below is a link to my swagger-ui and integration method.

@ApiOperation(httpMethod = "POST", 
            value = "Resource to authenticate a User", 
            response = ResponseState.class, nickname="Authenticate")
        @ApiImplicitParams({
                @ApiImplicitParam(name = "cmd", value = "Command Name", defaultValue="Authenticate",required = true, dataType = "string", paramType = "form"),
                @ApiImplicitParam(name = "email", value = "User's email", required = true, dataType = "string", paramType = "form"),
                @ApiImplicitParam(name = "password", value = "User's password", required = true, dataType = "string", paramType = "form"),
                })

http://api.nestkit.com/api/api-ui/#!/core/Authenticate

I'm using the following java servlet integration method

        <!-- maven dependency -->
    <dependency>
        <groupId>com.wordnik</groupId>
        <artifactId>swagger-servlet_2.10</artifactId>
        <version>1.3.6</version>
    </dependency>

<!-- swagger servlet reader -->
<servlet>
    <servlet-name>DefaultServletReaderConfig</servlet-name>
    <servlet-class>com.wordnik.swagger.servlet.config.DefaultServletReaderConfig</servlet-class>
    <load-on-startup>2</load-on-startup>
<init-param>
        <param-name>swagger.resource.package</param-name>
        <param-value>com.noracdev</param-value>
</init-param>
<init-param>
        <param-name>swagger.api.basepath</param-name>
        <param-value>http://api.nestkit.com</param-value>
</init-param>
<init-param>
        <param-name>api.version</param-name>
        <param-value>4.0</param-value>
</init-param>
ApiDeclarationServlet com.wordnik.swagger.servlet.listing.ApiDeclarationServlet ApiDeclarationServlet /api-docs/*

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions