Contact Free trial Login

To Start an APIkit Project

Documentation for APIkit 4.x

In this procedure, you import the RAML into Anypoint Studio that you created in Design Center or in a text editor.

  1. In Studio, click File > New > Mule Project. In Project Settings, set the following options:

    • Project Name: Type any name, for example, myproject.

    • In API Implementation, check this Specify API Definition File Location or URL option.

    • In Location, do one of the following:

      • Select Design Center if you created api.raml in Design Center. Login to Anypoint Platform if necessary, and select api.raml.

        import dc api
      • Alternatively, if you didn’t create the RAML in Design Center, select Browse Files.

        import browse api

        Browse to and select the api.raml that you created in a text editor.

  2. Accept the other default options, and click Finish.

    The api.raml and the included user-example.json file are imported into the project.

    When you finish, Studio launches the new project and generates a Main flow with an HTTP Listener, an APIkit Router, and error handling. Backend flows for consuming information from the users and usersbyid resources appear.

    files in apimain

    The api.raml and user-example.json file appear in src/main/resources/api.

    files in src-main-resources

Now, you are ready to run the API.

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.