Generate APK Configuration file

Following steps describe how to generate an APK configuration file.

  1. Develop a backend service and deploy it in an environment you prefer.

    To begin, it's essential to have a backend service that your API will interact with. The APK Configuration file is generated based on the API schema, which, in turn, relies on the functionality of your backend service.

  2. Generate an API schema file, typically an OpenAPI file for your service.

    You'll need an OpenAPI Specification 3.x, that describes the structure and behavior of your API. This file serves as the foundation for configuring your API and is essential for generating the APK Configuration file.

  3. Generate APK configuration file.

    You can start by providing your API schema file to the Configuration Service in APK. This service generates an APK configuration file that includes important API metadata, Rate Limiting details, security settings, and other necessary information. To generate the APK configuration file corresponding to your API Schema, use the following command that invokes the configuration service. You can assign the values according to the table below.

    The definition can be provided as a local file or as a URL containing a definition file.

    1. As a local file 

      curl -k --location 'https://api.am.wso2.com:9095/api/configurator/1.0.0/apis/generate-configuration' \
--header 'Host: api.am.wso2.com' \
--form 'definition=@"/Users/user/EmployeeServiceDefinition.json"'

    2. As a URL

    The following URLs contains a valid sample definitions that you can use.

    OpenAPI Specification for REST API: 

    curl -k --location 'https://api.am.wso2.com:9095/api/configurator/1.0.0/apis/generate-configuration' \
--header 'Host: api.am.wso2.com' \
---form 'url="https://raw.githubusercontent.com/wso2/apk/main/developer/tryout/samples/definitions/EmployeeServiceDefinition.json"' \
--form 'apiType="REST"'

    The sample output of the generate APK Configuration (apk-conf) file will be as follows

    ---
name: "EmployeeServiceAPI"
basePath: ""
version: "3.14"
type: "REST"
defaultVersion: false
endpointConfigurations:
    production:
        endpoint: "https://run.mocky.io/v3/1327c339-354b-4080-8296-f6268365e67b"
operations:
- target: "/employee"
    verb: "GET"
    secured: true
    scopes: []
- target: "/employee"
    verb: "POST"
    secured: true
    scopes: []

  4. Save the content to a file with extension .apk-conf. For example, EmployeeService.apk-conf.

  5. To optimize the configuration process, APK presents a VS Code plugin designed to offer syntax highlighting and intelligent suggestions. This plugin simplifies the incorporation of rate limitations, new resources, and security configurations into your API. Adapt the contents of the APK Configuration file as needed. For further details, refer to the section on Enhance Configuration with APK Config Language Support

Note

For production scenarios, it is recommended to commit the configuration to a source control system such as GitHub. This enables controlled and automated deployments through pipelines, ensuring a structured and controlled release process.

Once you have crafted your APK Configuration File, you have two convenient options for deploying them. Choose the deployment option that best suits your development workflow. Whether you prefer the customization capabilities of the Config Generator and CI/CD pipeline or the simplicity and speed of the Config Deployer, APK empowers you with flexible and efficient API deployment methods in the Kubernetes ecosystem.