Welcome to Java API Docs Search
Java API Docs is a web based tool to consolidate all Java Docs and provide Search facilities across the documentations conveniently for Java Developers.
We had found from the open source community, a desktop based search api tool written in java. We took this tool and made it as a small web application using Struts.
We have been using this in our intranet site for long time now.
We wrote this tool before other tools like JDocs were introduced. This tool helps
the developers to upload all the Java API documentation to a common intranet server and search for APIs across all the documentation.
What all does the tool allow you to do?
1. Upload a new documentation to the server.
2. Extensive Search facility across the documentations of the API's uploaded to the server.
3. Delete an existing API documentation from the server.
4. Rename a specific Documentation.
This is About Page
We are a bunch of developers who work for a eBanking product company. We try to use as much open source tools in our development. This is our first initiative to also start contributing to the opensource.
Steps to configure and deploy the APISearch Application
1. Unzip the contents of apisearch.zip into a folder.
2. Open the web.xml available under WEB-INF folder.
3. Modify the properties "docStorePath" and "propertiesFileName" by providing the full path of where you would like to store the Java Docs in the Server and the properties file name that contains the information about the various documentation available.
4. Run the Ant build using build.xml provided in the root folder.
5. You should find "apisearch.war" created under "target" folder.
6. Copy the "apisearch.war" to the Tomcat's webapps folder and restart Tomcat.
7. If not using Tomcat, Please go thru the documentation of specific Web Server on how to deploy a war file.