HApiDocWeb is the web service behind HApiDoc.
HApiDoc builds on top of CLAMS and provides a way to find and show examples on how to use some source code in project X based on similar usages in project Y.
The rationale behind HApiDoc is that running CLAMS in an enterprise environment with a large number of projects is not straightforward for the following reasons:
- In order to run CLAMS someone needs to install several dependencies which are OS-specific.
- Collecting the data that will be used as the service’s input is a manual and time-consuming task.
- Results are stored in local files and there is no web interface to present them to the users.
- The service does not integrate with any Git hosts to allow easier data collection or exploration of the results.
- There is no automation around running CLAMS; the user needs to manually run the service every time he/she wants to generate usage examples for a library.
The purpose of HApiDoc is to provide a set of components that cover the above limitations and to orchestrate any required tasks with the aim of providing an end-to-end solution for mining and presenting API usage examples to the users.
HApiDoc consists of 2 main components that run as Docker containers:
- HApiDocIndexer: This component aims to create the dataset that will be used from CLAMS, apply CLAMS on the dataset and store the results in MongoDB.
- HApiDocWeb: This is the web service for HApiDoc. It shows results on a neat web page.
HApiDocWeb can be run using Docker. You can either run vs a remote mongodb or using a linked mongodb (for testing purposes).
This will fetch all data from the mongo host (MONGO_DB_HOST) provided in docker-compose.yml.
docker-compose build
docker-compose up
This will make use of a linked mongodb container that's running locally. In this case, you need to run HApiDocIndexer locally as well to index data to mongodb in order to see any results in the website.
# You need to run mongo first using the command below:
docker run -d -p 27017:27017 --name mongo mongo:latest
docker-compose build
docker-compose -f docker-compose-with-linked-mongo-container.yml up
| url | Description |
|---|---|
/healthcheck |
Shows application health information. |
/calls |
Displays methods that have been indexed. |
If you would like to ask any questions about or discuss HApiDoc please contact a member of the project team.
Created by Nikos Katirtzis with thanks to Elliot West, Jose Nuñez Izu, Miguel Novais Pimenta, and Tom Wilkinson.
This project is available under the Apache 2.0 License.
Copyright 2018 Expedia Inc.