Wednesday, July 01, 2015

JAXRS analyzer, documenting your REST API an alternative. #swagger #javaee #jaxrs #maven

Lately, I have been considering using Swagger (core and it's related maven plugin) for one project, in order to provide some REST API documentation.

Despite the fact, that Swagger is indeed a very powerful library, doable to integrate on your JAXRS 2.0 code base and the maven plugin works at the end of the day I think that the extra annotations on my code  (my JAXRS resource classes) were creating an annotation mess. My classes ended up difficult to read and maintain, at least for me. Maybe I am getting tired lately with the annotation overload.

Recently, through Adam Bien's blog, I discovered JAXRS-analyzer , a project by S.Daschner and it's maven plugin . There is zero impact on extra annotations, completely compatible with my code base, fast and simple. Eventually it can output, swagger compatible json files, and then feed it to your swagger config and end up with a proper swagger based documentation site. For the time being I am not using this function rather than producing either AsciiDoc or plain text Rest API doc.

Of course there is still way to go and I am sure he will be adding features, but at the time being I consider it production ready for providing fast enough, some documentation to your API consumers. Give it a try.

Well done!

Friday, June 12, 2015

mind switch

Μέχρι τώρα η όλη αλλαγή, στο μυαλό μου ήταν λες και ήρθαμε διακοπές, και έχουμε να κάνουμε ένα project, ιδιαίτερα τις πρωτες εβδομάδες στο ξενοδοχείο. Τώρα όμως που βρίσκομαι σε ένα πολύ ωραίο δωμάτιο (σοφίτα) με τον αγαπημένο μου υπολογιστή, σύνδεση στο internet, σε ένα όμορφο σπίτι σε μια ωραία γειτονιά, μια ενδιαφέρουσα δουλειά, ένα αμάξι και ένα πακέτο καθημερινότητας (bonus ο πολυ καλός καιρός που έχει για την ώρα).. τώρα αρχίζει στο μυαλό ένα παιχνίδι.

Τώρα είναι λίγο που το μυαλό δεν ξέρει τι να διαλέξει, εννοώ πρέπει να το μάθεις να θεωρεί αυτό που ζεις σήμερα σαν την βάση σου από εδώ και πέρα, αυτό θα πρέπει να μάθει να λέει σπίτι. Περίεργο συναίσθημα να σας πω. Παρόλα αυτά θα ήταν άδικο να πω κάτι κακό για τον τόπο που μας φιλοξενεί, φυσικά υπάρχουν και άσχημα όπως σε όλες τις χώρες, αλλά ούτε μια στιγμή δεν έχω νιώσει ξένος...είναι ένα τόπος που όλοι είναι ξένοι και όλοι έχουν ένα κοινό. Ελπίδα για κάτι καλύτερο. Θα ακούσεις ιστορίες από νέους από την Ιταλία, την Ρωσία,Ουκρανία από την Πορτογαλία με μερικές θα ταυτιστείς. Αν μου λείπει κάτι; Μόνο πρόσωπα οικογένεια και φίλοι...τίποτα άλλο.

Χαιρετώ από το μάλλον καλοκαιρινό Λουξεμβούργο.

Wednesday, May 27, 2015

Boot2Docker shellInit - set the DOCKER_HOST in your macosx Terminal

Personal note to me rather than something special, if you use Boot2Docker on your MacOSX and you want an easy way to  your docker command line client to connect to the underlying boot2docker vm,  add on your ~/.bash_profile file the following line. Credits to this stackoverflow post.

$(boot2docker shellinit 2>/dev/null)