Allow exclusion of endpoints

Filtering/exclusion of endpoints should be allowed.

It would be nice to be able to filter which endpoints should be exported to Swagger.yaml using the @ApiModelProperty(access="...") annotation.

Following is an example of my proposal:

@Path(TestClass.PATH)
public class TestClass {
    static final String PATH = "/path/goes/here";
    @Get
    @ApiOperation( value= "I'm hidden from the public")
    @ApiModelProperty(name = "hiddenMethod", access="internal")
    public Response hiddenMethod() {
        ...
    }
    @Post
    @ApiOperation( value= "Go ahead. Use me")
    public Response freeForAll(Thingy thingy) {
        ...
    }
}

POM:

<plugins>
    <plugin>
        <artifactId>swagger-maven-plugin</artifactId>
        ...
        <configuration>
            <apiSources>
                <apiSource>
                    <locations>
                        example.endpoints
                    </locations>
                    <apiModelPropertyAccessExclusions>
                        <apiModelPropertyAccessExclusion>
                            internal
                        </apiModelPropertyAccessExclusion>
                    </apiModelPropertyAccessExclusions>
                    <swaggerDirectory>public</swaggerDirectory>
                </apiSource>
                <apiSource>
                    <locations>
                        example.endpoints
                    </locations>
                    <swaggerDirectory>internal</swaggerDirectory>
                </apiSource>
            </apiSources>
        </configuration>
    </plugin>
</plugins>

This would produce two yaml-files, one including the /path/goes/here-GET and one excluding it

[zarub2k]

@APIOperation(hidden=true) with this annotation we can ignore the rest endpoints while generating Swagger

[jahlbornG]

we would also love for a good way to generate public and private docs separately. we use the hidden flag on a lot of stuff. it’d be nice to simple have an option like “ignore hidden” which would include everyting.