Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Spring Annotation Support #51
I know there is an outstanding pull request (#16) out there for spring annotation support, but it's missing tests, and doesn't merge anymore. I'd like to know what you think about a do-over on this.
My current thinking is that it should be part of the jsondoc-springmvc module, and basically just map the spring annotations over to the core classes. That way, non-spring folks can keep using the core library without pulling spring along for the ride.
The Api annotations would supplement things that are missing from the spring annotations (descriptions, groupings, etc.). Here are some specific things that I know need to be addressed in order to call this done. Other folks can add to this as needed.
After poking at this a bit, I'm almost wondering if it might be easier to just have a separate set of method annotations for the spring stuff. That will allow the two method annotations to live independently of each other. They would still map to the same base pojo. Just throwing some thoughts out there for discussion.
I think I've got a good first pass at this ready to go. There are no changes to the underlying library (except what my IDE tried to do with imports, and some method scoping cleanup). If you have jsondoc-springmvc on your classpath, and the appropriate annotations, it just works. I'm going to be working with some more complicated apis on this tomorrow, but I'll go ahead and give you a pull request to look over.
referenced this issue
Jan 4, 2015
Sorry, one last thing on this. I'd really like to see something like what I did with the ApiDocScanner work its way into the project. That way, folks fan add their own mappers to the documentation classes that are the core of this project. Thanks again for all your work.
thank you for your proposal. In these days I will have very few time to work on the project, so I'll be very slow in responding to issues and pull requests. The next things I wanted to work on in the project are (and this would be the roadmap I was thinking about):
Anyway I had a quick look at the code you pushed and I have a few comments:
At the end, here are the steps I have in mind to make spring mvc (or other frameworks) and jsondoc cohexist:
Some additional notes: