API Template

In this tutorial, you’ll learn how to create a Liferay API as a Liferay module. To create a Liferay API via the command line using Blade CLI or Maven, use one of the commands with the following parameters:

blade create -t api -v 7.0 [-p packageName] [-c className] projectName

or

mvn archetype:generate \
    -DarchetypeGroupId=com.liferay \
    -DarchetypeArtifactId=com.liferay.project.templates.api \
    -DartifactId=[projectName] \
    -Dpackage=[packageName] \
    -DclassName=[className] \
    -DliferayVersion=7.0

You can also insert the -b maven parameter in the Blade command to generate a Maven project using Blade CLI.

The template for this kind of project is api. The api template creates a simple api module with an empty public interface. For example, suppose you want to create an API project called my-api-project with a package name of com.liferay.docs.api and a class name of MyApi. You could run the following command to accomplish this:

blade create -t api -v 7.0 -p com.liferay.docs -c MyApi my-api-project

or

mvn archetype:generate \
    -DarchetypeGroupId=com.liferay \
    -DarchetypeArtifactId=com.liferay.project.templates.api \
    -DgroupId=com.liferay \
    -DartifactId=my-api-project \
    -Dpackage=com.liferay.docs \
    -Dversion=1.0 \
    -DclassName=MyApi \
    -Dauthor=Joe Bloggs \
    -DliferayVersion=7.0

After running the command above, your project’s directory structure looks like this:

• my-api-project
  • gradle (only in Blade CLI generated projects)
    • wrapper
      • gradle-wrapper.jar
      • gradle-wrapper.properties
  • src
    • main
      • java
        • com/liferay/docs/api
          • MyApi.java
      • resources
        • com/liferay/docs/api
          • packageinfo
  • bnd.bnd
  • build.gradle
  • [gradlew|pom.xml]

The generated module is a working application and is deployable to a Liferay DXP instance. To build upon the generated app, modify the project by adding logic and additional files to the folders outlined above.