Skip to content
This repository was archived by the owner on Nov 13, 2019. It is now read-only.

Conversation

@DenEwout
Copy link

Dear maintainers of the yum-repo-server,

We noticed you're not offering any documentation of your REST API. Since we have developed a pretty cool maven plugin that extracts beautiful API documentation straight from your Java source code, we thought we'd help you out. We're completely free for open-source so we've already added the plugin + free license to your pom. With the open-source license you get access to all the paying features, free of charge. Give it a try and merge if you like it. Any feedback is welcome.

You can find your documentation in the target/miredot folder after running mvn package. I took a look at the project and I have a few tips in order to improve your documentation:

  1. Add javadoc commentary, not only will this improve your code, it will also automatically improve the documentation as Miredot pulls your comments straight from the code.
  2. Explicitly declare any runtime exceptions your rest endpoints might throw. That way Miredot can pick up which status codes to document (using Spring's "@ResponseStatus" annotation on your custom exceptions)

If you have any questions/feedback or problems, please let us know!

Kind Regards,
Ewout & The Miredot team.

@mriehl
Copy link
Contributor

mriehl commented Feb 12, 2016

Folks,

is it possible to make the change so that the whole pom doesn't change? The diff is a bit overwhelming. Feels like this change should be 3-4 lines additions, tops. But it's 600 additions/deletions. I am not reading through 1,2k lines of XML anytime soon.

@DenEwout
Copy link
Author

Apologies, I accidentally reformatted the pom file in IntelliJ. I created a new pull request:

Adds Miredot configuration and keeps the formatting of the pom.xml. #68

@DenEwout DenEwout closed this Feb 12, 2016
@DenEwout DenEwout deleted the miredot-documentation branch February 12, 2016 16:40
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants