Skip to content

Latest commit

 

History

History
 
 

ui-api-layer

README.md

UI API Layer

Overview

This project includes a server that exposes the GraphQL API for all Kyma UIs. It consumes the Kubernetes API using the K8S Go client. This document describes how to use the application and how to develop new features in this project.

NOTE: The description of the application configuration, the project structure, the architecture, and other project-specific details are located in the docs directory.

See the GraphQL schema definition file for the list of supported queries and mutations.

Prerequisites

Use the following tools to set up the project:

Usage

Run a local version

To run the application without building the binary, run this command:

APP_KUBECONFIG_PATH=/Users/$USER/.kube/config APP_VERBOSE=true APP_CONTENT_ACCESS_KEY={accessKey} APP_CONTENT_SECRET_KEY={secretKey} APP_CONTENT_VERIFY_SSL=false APP_REMOTE_ENVIRONMENT_GATEWAY_INTEGRATION_NAMESPACE=kyma-integration APP_REMOTE_ENVIRONMENT_CONNECTOR_URL=http://dummy.url go run main.go

For the descriptions of the available environment variables, see the Configuration document.

The service listens on port 3000. Open http://localhost:3000 to see the GraphQL console in your browser.

Use GraphQL console on cluster

Before using the console on a cluster, set a valid token for all requests. Click the Header option at the bottom of the GraphQL console and paste this snippet:

{
    "Authorization": "Bearer {YOUR_BEARER_TOKEN}"
}

After you paste the custom HTTP header, reload the page. GraphQL console allows you to access the schema documentation and test queries, mutations, and subscriptions.

Build a production version

To build the production Docker image, run this command:

docker build {image_name}:{image_tag}

The variables are:

  • {image_name} - name of the output image (default: ui-api-layer)
  • {image_tag} - tag of the output image (default: latest)

Development

Install dependencies

This project uses dep as a dependency manager. To install all required dependencies, use the following command:

dep ensure -vendor-only

Generate code from GraphQL schema

This project uses the GQLGen library, which improves development by generating code from the GraphQL schema definition.

  1. Define types and their fields in /internal/gqlschema/schema.graphql using the Schema Definition Language.
  2. Execute the ./codegen.sh script to run the code generator.
  3. Navigate to the /internal/gqlschema/ directory.
  4. Find newly generated methods in the ResolverRoot interface located in ./schema_gen.go.
  5. Implement resolvers in specific domains according to the project structure and rules in this guide. Use generated models from ./models_gen.go in your business logic. If you want to customize them, move them to a new file in the gqlschema package and include in the ./config.yml file.

To use advanced features, such as custom scalars, read the documentation of the used library.

Run tests

To run all unit tests, execute the following command:

go test ./...

Verify the code

To check if the code is correct and you can push it, run the before-commit.sh script. It builds the application, runs tests, checks the status of the vendored libraries, runs the static code analysis, and ensures that the formatting of the code is correct.