Generierung eines Clients mithilfe der OpenAPI-Spezifikation

Sie können die folgende YAML-Spezifikation für OpenAPI verwenden, um ein SDK mit einem Tool wie OpenAPI Generator zu erstellen. Sie können diese Spezifikation so aktualisieren, dass sie hartcodierte Werte für Anwendung, Umgebung oder Konfiguration enthält. Sie können auch zusätzliche Pfade hinzufügen (wenn Sie mehrere Konfigurationstypen haben) und Konfigurationsschemas einbeziehen, um konfigurationsspezifische typisierte Modelle für Ihre SDK-Clients zu generieren. Weitere Informationen zu OpenAPI (auch bekannt als Swagger) finden Sie in der OpenAPI-Spezifikation.

openapi: 3.0.0
info:
  version: 1.0.0
  title: AppConfig Agent Lambda extension API
  description: An API model for the AppConfig Agent Lambda extension. 
servers:
  - url: https://localhost:{port}/
    variables:
      port:
        default:
          '2772'
paths:
  /applications/{Application}/environments/{Environment}/configurations/{Configuration}:
    get:
      operationId: getConfiguration
      tags:
        - configuration
      parameters:
        - in: path
          name: Application
          description: The application for the configuration to get. Specify either the application name or the application ID.
          required: true
          schema:
            type: string
        - in: path
          name: Environment
          description: The environment for the configuration to get. Specify either the environment name or the environment ID.
          required: true
          schema:
            type: string
        - in: path
          name: Configuration
          description: The configuration to get. Specify either the configuration name or the configuration ID.
          required: true
          schema:
            type: string
      responses:
        200:
          headers:
            ConfigurationVersion:
              schema:
                type: string
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
          description: successful config retrieval
        400:
          description: BadRequestException
          content:
            application/text:
              schema:
                $ref: '#/components/schemas/Error'
        404:
          description: ResourceNotFoundException
          content:
            application/text:
              schema:
                $ref: '#/components/schemas/Error'
        500:
          description: InternalServerException
          content:
            application/text:
              schema:
                $ref: '#/components/schemas/Error'
        502:
          description: BadGatewayException
          content:
            application/text:
              schema:
                $ref: '#/components/schemas/Error'
        504:
          description: GatewayTimeoutException
          content:
            application/text:
              schema:
                $ref: '#/components/schemas/Error'

components:
  schemas:
    Error:
      type: string
      description: The response error