Quickstart Guide

This guide will walk you through creating your first project and microservice on the platform. While Ender, our AI Agent, will guide you interactively, you remain in complete control of your project. Let’s get started!

Setup your LLM API Keys

Make sure you have setup the LLM API Keys. Please visit see the Getting Started guide to setup your LLM API Keys.

Create Your First Endpoint (aka Application)

Step 1: Create a New Project

Fill out the form with the following details:

Project Name
Choose a meaningful and contextual name for your project. This name will appear in the Dashboard sidebar for easy reference.

Package Name
Since this is a Java Spring Boot project, specify your desired root package name. This forms the foundation of your project’s code structure.

Description
Provide a brief overview of your project. This helps Ender, our AI Agent, understand your requirements and offer contextual recommendations.

Context
Though optional, we highly recommend adding Project Context. Be concise yet descriptive to provide additional details or requirements for your project.

Select Your LLM Provider
From the dropdown menu, choose your preferred LLM provider. The options available depend on the API keys you’ve set up on the platform.

Click on "Create New Project"
After completing the form, click on Create New Project. You’ll be automatically redirected to the Project Page upon successful project creation.

New Project Form

Step 2: Create Your First Microservice

Before diving in, take a moment to review the Project Page Layout for a better understanding of its structure.

Your New Project Page

On the Project Page, you’ll meet Ender, ready to assist you with recommendations and next steps. For this guide, click on "Recommend me a list of microservices to be created."

Microservice Recommendations

Ender will generate a list of suggested microservices tailored to your project: Microservice Recommendations

Each microservice will include a name and description.
You can add, remove, or edit services based on your project requirements.

To keep things simple, click on "Continue with these services" to proceed.

Define Entity Fields

Ender will now recommend entity fields for your first service:

Each field includes a name, type, description, and constraints.
You can add, remove, or edit fields as needed.

This step demonstrates Endpoints AI’s interactive nature. Simply click on "Continue with these fields" to proceed.

Generate Code

Ender will then generate the complete code for your first microservice. Behind the scenes, the platform is:

Creating the codebase.
Generating APIs and endpoints.
Preparing Swagger documentation.

Once Ender completes the process, you’ll see the new microservice in both the Canvas and the Sidebar. The Swagger documentation for your service will also appear in the chat window. Your First Microservice

Congratulations 🎉

You’ve successfully created your first microservice! Now you can explore more platform features and expand your project.

Step 3: Explore Your First Microservice

While you can continue creating services, let’s take a closer look at the first one:

Sidebar: Click on the service name to open the project repository. Browse the project structure and view file contents by selecting them.
GitHub Integration: Click on the View in GitHub button to access the code in your linked GitHub repository.
Run it locally: You can of course run the service locally and test it.

Steps to run the service locally:

Clone the repository to your local machine using the command git clone <repository-url>
Navigate to the project directory using the command cd <project-name>
You can either run mvn clean install to build the project or directly run the project using the command mvn spring-boot:run. In this case you would have to set up your MySQL service.
OR
There is a docker-compose file in the repository. You can run the project using docker compose up.
Once the project is running, you can access the service at http://localhost:8080/swagger-ui.html

Running your Service Locally

You can find the instructions in the README file in the repository.

Step 4: Engage with Ender

Ender is your AI companion throughout the development process. Designed to be intuitive and interactive, Ender can:

Guide you in building backend services.
Answer questions about development best practices.
Provide recommendations tailored to your project.

Ender is not a chatbot—it’s your learning and development partner. Whether you want to build complex microservices or deepen your understanding of backend architecture, Ender is here to help. Best of all, you don’t need to craft complex prompts; we’ve made interaction simple and natural.

To learn more about engaging with Ender, visit the Ender is Your Friend page.

Try It Out!

Head over to the Endpoints AI and create your first project. If you have any questions or need assistance, feel free to reach out to us. Happy coding! 🚀

Quickstart Guide

On this page