wkennedy / swagger4spring-web

Swagger support for Spring MVC
89 stars 46 forks source link

Exclude an API #14

Closed mzruya closed 11 years ago

mzruya commented 11 years ago

Hi, i'm happy to find a project that looks like a solid foundation for proper Swagger Spring MVC integration, i'd like to propose an enhancement.

Some API's are internal, and u wouldn't want to expose them to the customer in the form of swagger documents, but u would still like to document them in your code using the annotations like any other API.

I propose adding an annotation in the form of @ApiExclude (or something with a similar name), this annotation can be added to a class or method.

I would be happy to implement and send a pull request,

What do u think ?

Thanks..

wkennedy commented 11 years ago

Hey there mzruya,

Thanks for the compliment! I think the ability to exclude is a great idea. If you want to implement the exclude annotation, I'll be more than happy to merge it.

Thanks!

wkennedy commented 11 years ago

https://github.com/wkennedy/swagger4spring-web/pull/17