Is there an OpenGrok API?

Question

Is there an API for OpenGrok? I'm interested in mining the results in either Perl or Java. At the moment, I could perform HTML scrapping against the results, but seems less-than-ideal.

As per its website, it leverages Lucene, but no real info on how to connect to it other than via HTML.

score 5 · Answer 1 · edited Feb 05 '18 at 17:11

5

Starting in OpenGrok 0.13, there is a simple REST API.

With OpenGrok 1.0 there is a JSON API.

edited Feb 05 '18 at 17:11

JasonMArcher

14,195
22
56
52

answered Apr 17 '17 at 17:51

eh1160

674
1
6
14

Apparently it's only available through localhost – makhdumi Jul 10 '19 at 23:23

score 2 · Answer 2 · answered Apr 19 '13 at 18:28

2

Opengrok supports a command line interface that may be able to provide what you're looking for.

Example:

$ java -cp ./opengrok.jar org.opensolaris.opengrok.search.Search -R /var/opengrok/etc/configuration.xml -f "My Search"

answered Apr 19 '13 at 18:28

arcdegree

2,710
3
27
38

score 1 · Answer 3 · answered Oct 31 '13 at 14:02

1

This fork has a JSON API: https://github.com/Goyaka/OpenGrok/blob/f70d78e743a0a389b46ea36c4785182ee8f03e13/src/com/goyaka/opengrok/web/SearchServlet.java

This issue discusses it: https://github.com/OpenGrok/OpenGrok/issues/422

answered Oct 31 '13 at 14:02

Philippe Ombredanne

2,017
21
36

Is there an OpenGrok API?

3 Answers3