Reference documentation for Amplication plugin development.

Reference

Amplication

Amplication helps teams bring order to the chaos of large-scale software development by creating Golden Paths and streamlining workflows that make development faster, more consistent, and easier to manage across teams.

What Is Amplication?

Understand the fundamental concepts that power Amplication to standardize, govern, and automate your software ecosystem.

Concepts

Answers to your most common questions about Amplication usage, management, and implementation

FAQs

Establish and enforce organizational standards for resource creation and maintenance with Amplication's Day Zero capabilities.

Overview

Standardize Your Foundations

Empower your organization to establish and maintain a standardized & future-proof software foundation with Blueprints.

Blueprints

Configure standardized fields and relationships within Blueprints to enforce architectural consistency.

Blueprint Properties & Relations

Built-in vs Custom Standards

Amplication's Standards vs Custom Standards

Quickly generate a production-grade service using our opinionated, pre-configured Node.js or .NET code generation engines.

Use Amplication Standards

Use Amplication Standards with a Pre-Configured Opinionated Service

Establish a unified system for tagging and describing all your Amplication resources, enabling powerful filtering, grouping, and standardized code generation across your organization.

Catalog Properties

Codify organizational standards using Amplication's Private Plugins

Private Plugins

Establish golden paths for your development team and maintain auto-updating standards with Amplication's Live Templates.

Live Templates

Unlocking Standardized and Scalable Development with Internal Developer Platforms + Amplication

Integrating with IDP

Integrating Amplication with Internal Developer Platforms (IDP)

Port is an Internal Developer Portal (IDP) that helps engineering teams manage their software catalog and accelerate development.

Integrate with Port

Backstage is an open platform for building developer portals. Here's how to integrate Amplication with Backstage.

Integrate with Backstage

Learn how to integrate Amplication with other Internal Developer Platforms (IDPs)

Integrate with Other IDPs

Integrating Amplication with Other IDPs

Learn how to generate an API token to use with Amplication integrations

API Token Generation

Generating API Tokens for Amplication Integrations

Learn how Amplication facilitates seamless Git integration for managing every resource in your organization

Smart Git Sync

Integrate Amplication with GitLab for streamlined git management for all your resources.

Sync With GitLab

Integrate Amplication with GitHub for centralized control and streamlined Git workflows across all your resources.

Sync With GitHub

Integrate Amplication with Bitbucket for centralized resource management and smart Git workflows across your organization.

Sync With Bitbucket

Integrate Amplication with Azure DevOps to centralize resource management and ensure consistent Git workflows within the Microsoft ecosystem.

Sync With Azure Devops

Integrate Amplication with AWS CodeCommit for secure, compliant, and centralized Git management of your service foundations within AWS.

Sync With AWS CodeCommit

Rapidly build production-ready resources with standardized foundations using Amplication's Day One capabilities.

Accelerate Resource Creation

How to self-serve resource creation by selecting and launching resources from predefined Blueprints.

Create from a Blueprint

Create Resource from Blueprint

Quickly generate new services or blueprints based on pre-configured templates.

Create from a Template

Create Resource from Live Template

Learn how Amplication AI (Jovu) helps enterprise teams automate development, generate code, and maintain best practices through AI-powered suggestions and natural language commands.

Jovu

Explore practical examples of how Amplication AI (Jovu) accelerates service creation and simplifies development workflows for platform teams.

Jovu Examples

Instructions for enterprise developers on connecting newly created resources to dedicated repositories within Amplication.

Resource-Level Git Setup

Guide for enterprise developers on adjusting inherited properties and metadata based on Day Zero standards.

Edit Catalog Properties

Learn how to install and manage both public and private plugins in your Amplication resources to extend functionality and maintain organizational standards.

Use Private & Public Plugins

How to Use Private & Public Plugins

Learn how to create, manage, and visualize entities in Amplication to build robust resources rapidly.

Entities

Working with Entities

Learn how to create and configure entity fields, their data types, and advanced customization options in Amplication.

Fields

Entity Fields

Learn how to define and manage one-to-one, one-to-many, and self-relation relationships between entities in Amplication.

Relationships

Define Relationships Between Entities

Define custom data structures (DTOs) and API endpoints (Actions) in Amplication to build robust and standardized services, faster.

Custom Types & Actions

Learn how Amplication's plugin-based authentication system simplifies secure user authentication for platform teams with flexible provider options.

Authentication Explained

Learn how to secure your Amplication resources with authentication plugins. Supports JWT, Basic Auth, Auth0, Supertokens, SAML, Keycloak for Node.js and ASP.NET Core Identity for .NET applications.

Authentication Providers

Authentication Provider Plugins

Learn about managing authentication entities within the Amplication platform.

Authentication Entity

Learn how to configure roles and permissions on your Amplication resource to control access to entities and fields, ensuring security and standardization.

Roles & Permissions

Configure Roles & Permissions

Review all modifications before code generation, ensuring complete control over your resource's code.

Pending Changes

View Pending Changes

Guide for enterprise developers on generating code for their services using Amplication.

Generate Code

Quickly inspect the production-ready code Amplication generates directly within the platform.

Code View

Monitor code generation, inspect build logs, and access Git pull requests directly from Amplication's Commits tab.

Commits

Proactively manage and update live apps at scale with Amplication's Day Two capabilities.

Maintain Operational Excellence

Gain unparalleled visibility and control over your entire resource ecosystem with Amplication's Software Catalog.

Software Catalog

Streamline team collaboration, enhance visibility, and ensure accountability across your Amplication projects with centralized user and team management.

User & Team Management

Gain unparalleled visibility and control over your entire software ecosystem with Amplication's multi-dimensional Architecture Graph.

Architecture Graph

Learn how Amplication can help you keep golden paths current by updating templates.

Update Live Templates

Keep your Private Plugins current in Amplication to ensure consistent standards and access the latest features and fixes.

Update Private Plugins

Learn how to track, manage, and resolve technical debt across multiple resources in Amplication using Live Templates, Private Plugins, and automated updates.

Resolve Technical Debt

Resolve Technical Debt Across Multiple Resources

Build and maintain custom plugin code extensions that align with your organization's unique requirements.

Codify Your Standards with Plugins

Customize and extend Amplication's code generation process using Before and After lifecycle functions in plugins.

Lifecycle Functions

Before and After Lifecycle Functions

Learn how to install and use the Amplication VS Code extension to streamline plugin development.

VS Code Extension

Amplication Visual Studio Code Extension

Learn how to set up the required Git repository and folder structure for private plugins in Amplication.

Repository & Folder Setup

Setting Up Repository and Folder Structure for Private Plugins

Customize your plugins to align with team standards and enhance developer experience. Tailor display, code generators, and versions for optimal use within your organization.

Configure Plugin

Configure Your Plugin

Learn how to define customizable settings for your Private Plugins, tailoring them to specific use cases and versions.

Define Plugin Settings

Learn how to efficiently test your private Amplication plugins during development using Dev Versions, ensuring a smooth integration

Test Plugin

Test Your Private Plugin

Learn how to publish private Amplication plugins, including versioning, tagging your Git repository, and making your plugins available for organizational use.

Publish Plugin

Publish Your Private Plugin

Learn how to develop Amplication plugins with practical techniques and code examples.

Techniques and Examples

Building Amplication Plugins - Techniques and Examples

Learn how to create and use a shared library across multiple Amplication plugins using npm and Webpack configuration.

Using a Shared Library in Amplication Plugins

Amplication simplifies plugin development by providing a boilerplate template that serves as a starting point. This guide walks you through the process of setting up the boilerplate needed for Amplication plugins using a predefined plugin template.

Build New Plugins Using Amplication

Use Amplication to Generate the Boilerplate Needed for New Amplication Plugins

Overview of Amplication's AST libraries for code generation

AST Libraries

Common interfaces and types for AST generation

AST Types

Library for generating C# code through an abstract syntax tree

C# AST

Library for generating Java code through an abstract syntax tree

Java AST

Library for generating Python code through an abstract syntax tree

Python AST

Create Blueprint

This event run before and after the creation of all modules in the context of this blueprint

Create Modules

This event run for each module in the list of modules of the blueprint

Create Module

This event wraps the entire process of generation of the server-side code.

Create Server

Creates the docker-compose.yml file of the service

Create Server Docker Compose

Creates the docker-compose.dev.yml file of the service

Create Server Docker Compose Dev

Create Server Dot Env

Creates the Authorization directory with the selected strategy

Create Server Auth

Create the package.json file of the service.

Create Package Json

Create Entity Service

Create Entity Service Base

Create Entity Controller

Creates the base controller of an entity.

Create Entity Controller Base

Create Entity Resolver

Create Entity Resolver Base

Creates the service of the Kafka message broker.

Create Message Broker Service

Creates the base service of the Kafka message broker.

Create Message Broker Service Base

Creates the NestJS of the message broker.

Create Message Broker NestJS Module

Creates the client options of the message broker.

Create Message Broker Client Options Factory

Create Message Broker Topics Enum

Create Prisma Schema

Initializes the creation of the .NET server.

Creates or updates the appsettings.json file for the .NET server

Create Server Appsettings

Sets up authentication for the .NET server.

Creates the main Program.cs file for the .NET application.

Create Program File

Creates or updates the .csproj file for the .NET server.

Create Server Csproj

Creates or updates the Docker Compose file for the .NET server.

Creates the .gitignore file for the server.

Create Server Git Ignore

Creates a model class for a specific entity in the .NET application.

Get Started

Lifecycle & Coding Details

Developing a Plugin

Guides & Tutorials

AST Libraries

Blueprint Plugin Events

Node.js Plugin Events

.NET Plugin Events

Reference