https://github.com/sdaschner/jaxrs-analyzer

Creates REST documentation for JAX-RS projects
https://github.com/sdaschner/jaxrs-analyzer

Last synced: about 12 hours ago
JSON representation

Creates REST documentation for JAX-RS projects

• Host: GitHub
• URL: https://github.com/sdaschner/jaxrs-analyzer
• Owner: sdaschner
• License: apache-2.0
• Created: 2015-02-27T13:52:03.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-04-24T22:56:35.000Z (over 1 year ago)
• Last Synced: 2024-08-02T13:19:29.404Z (3 months ago)
• Language: Java
• Size: 1.01 MB
• Stars: 319
• Watchers: 27
• Forks: 101
• Open Issues: 75
• Metadata Files:
  • Readme: README.adoc
  • Changelog: Changelog.adoc
  • License: LICENSE

Awesome Lists containing this project

README

        
= JAX-RS Analyzer

Sebastian Daschner

Generates an overview of all JAX-RS resources in a project by bytecode analysis.

*Yet another such JAX-RS tool?* +

Yes, but this gathers the information about the JAX-RS resource classes by bytecode analysis (not just by reflection).

This gains more information in several situations. You don't need additional annotations on your JAX-RS resource methods.

Using the JSR 339 standard is sufficient.

Java 8 is needed for the Analyzer.

For usage see the https://github.com/sdaschner/jaxrs-analyzer/blob/master/Documentation.adoc[documentation].

== Maven Plugin

The Analyzer can be added to your project via https://github.com/sdaschner/jaxrs-analyzer-maven-plugin[Maven plugin].

== Gradle Plugin

For `Gradle` based projects - third-party https://github.com/grimmjo/jaxrs-analyzer-gradle-plugin[Gradle plugin] could be used.

== Standalone

Instead of using the Maven plugin, the tool can also run directly from the jar file.

You can download the latest version https://github.com/sdaschner/jaxrs-analyzer/releases[here].

== Backends

The Analyzer supports Plaintext, AsciiDoc, Markdown and Swagger as output format.

== Documentation / Feature list

+...+ can be found https://github.com/sdaschner/jaxrs-analyzer/blob/master/Documentation.adoc[here].

Feedback, bug reports and ideas for improvement are very welcome! Feel free to fork, comment, file an issue, etc. ;-)