Code Generation Tiles

This page documents tiles that provide automated code generation capabilities for NGSS projects.

Project Artifact Generation Tiles

These tiles generate various project artifacts and documentation.

effective-metadata-generator-tile

Generates effective metadata by merging project metadata with default NGSS metadata.

Purpose

Combines project-specific metadata.yaml with metadata-default.yaml to produce a complete effective-metadata.yaml file.

Features

  • Metadata file merging and validation

  • NGSS standard metadata enforcement

  • Configuration validation

  • Integration with deployment pipelines

Usage

Automatically included in most NGSS service build conventions to ensure proper metadata for deployment and operations.

deployment-readme-generator-tile

Automatically generates deployment-related README documentation.

Purpose

Creates standardized deployment documentation based on project metadata and configuration.

Features

  • Automated dibr.md generation

  • Deployment instruction documentation

  • Configuration documentation

  • Service dependency documentation

Usage

Helps maintain up-to-date deployment documentation without manual maintenance overhead.

service-dependencies-readme-tile

Generates documentation for service dependencies and external integrations.

Purpose

Automatically documents service dependencies, external APIs, databases, and other integrations specified in metadata.yaml helm.dependencies field.

Features

  • Dependency documentation generation

  • Service integration mapping

  • External API documentation

  • Database schema documentation

Usage

Provides visibility into service dependencies for operational and development teams.

OpenAPI Code Generation Tiles (deprecated)

These tiles provide automated code generation from OpenAPI/Swagger specifications.

openapi-client-generator-tile (deprecated)

Generates client libraries from OpenAPI specifications.

Purpose

Automatically generates HTTP client code from OpenAPI/Swagger specifications for consuming external APIs.

Features

  • Client library generation from OpenAPI specs

  • Multiple language support

  • Customizable client configurations

  • Integration with Maven build lifecycle

Usage

Use when your service needs to consume external APIs that provide OpenAPI specifications.

openapi-java-service-generator-tile (deprecated)

Generates Java service artifacts from OpenAPI specifications.

Purpose

Automatically generates server-side Java code including interfaces, models, and API documentation from OpenAPI specifications.

Features

  • Java service interface generation

  • Model class generation from schemas

  • Spring Boot integration

  • Swagger UI resource generation

  • Automatic cleanup of temporary generation artifacts

Configuration

  • Input specification: src/main/resources/swagger.json

  • Output directory: src/main/resources

  • Generator: openapi (standard OpenAPI generator)

Process

  1. Reads OpenAPI specification from swagger.json

  2. Generates OpenAPI artifacts and documentation

  3. Automatically cleans up temporary openapi.json files

  4. Integrates generated code with Maven compilation

Usage

Use for API-first development where you define your service contract in OpenAPI and generate the Java implementation scaffolding.