API Connection

An API Connection represents a connection to an external API service within the Smarter platform. It encapsulates the necessary configuration and credentials (Smarter Secret) required to interact with the API,

Example API Connection Manifest
apiVersion: smarter.sh/v1
kind: ApiConnection
metadata:
  description: Api connection Stackademy courses catalogue /api/v1/tests/stackademy/course-catalogue/
  name: smarter_test_api
  version: 0.1.0
  tags:
    - test
    - api
    - sample
  annotations:
    - smarter.sh/smarter-test-api/creator: QA Team
    - smarter.sh/smarter-test-api/purpose: unit testing
    - smarter.sh/smarter-test-api/release-date: 2024-06-15
    - smarter.sh/smarter-test-api/backward-compatibility: true
spec:
  connection:
    baseUrl: http://localhost:9357/api/v1/tests
    headers: {}
    method: GET
    parameters: {}
    timeout: 30
    useSsl: false
    authenticationMethod: none
    maxOverflow: 10
    poolSize: 5
    port: 8000

Technical References