Welcome to the Alfresco REST API Explorer

The API Explorer allows you to browse and experiment with the REST APIs available in the Alfresco platform.

Quickstart

You can find the pre-built Docker image on Docker Hub: alfresco/rest-api-explorer.

To run the latest built API Explorer on localhost:8080 using Docker, use the following command:

docker run -p 8080:8080 alfresco/rest-api-explorer:master

You can also browse the latest GitHub Pages version of the API Explorer directly at https://alfresco.github.io/rest-api-explorer/.

Development

Building WAR file

• mvn install

You now have a target/api-explorer.war, drop this into your Application server that is running alfresco.war

Running via local Jetty

You can run the project as a packaged web application using an embedded Jetty server. This is useful for changing documentation and endpoint descriptions but it means that the "Try it Out!" button will not work.

• mvn jetty:run-war

Now the application is running at http://localhost:8085/api-explorer

Building for GitHub Pages

The GitHub Pages build is located in the .github/gh-pages directory. It is suitable if you want something quick and easy to test locally without any java dependencies. More details in the GitHub Pages Build Scripts section.

Building with Docker

You can build a Docker image of the API Explorer and run it in a container.

Note: The AGS classification API definition (gs-classification-api.yaml) is automatically synced from the enterprise repository by the Sync AGS Definition workflow and committed to this repository.

Build the Docker image:

docker build -t api-explorer . --load

Run the Docker container:

docker run -p 8080:8080 api-explorer

Browse the API Explorer at http://localhost:8080.

Building an older release

To build an older release, before Dockerfile and GitHub Pages build scripts were available, you can check out the specific tag, materialize the necessary files, and then build the Docker image:

TAG=23.3.0
git checkout $TAG
git checkout master -- Dockerfile .github/gh-pages
docker build -t api-explorer:$TAG . --load
docker run -p 8080:8080 api-explorer:$TAG

License

See LICENSE file for details.