@grafana/openapi-to-k6 0.1.2 → 0.2.1

package/examples/get_request_with_path_parameters_schema/split/simpleAPI.schemas.ts

@@ -0,0 +1,12 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Simple API
+ * An API with a single GET request that takes a path parameter
+ * OpenAPI spec version: 1.0.0
+ */
+export type GetItemById200 = {
+  description?: string
+  id?: string
+  name?: string
+}

package/examples/get_request_with_path_parameters_schema/split/simpleAPI.ts

@@ -0,0 +1,90 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Simple API
+ * An API with a single GET request that takes a path parameter
+ * OpenAPI spec version: 1.0.0
+ */
+import { URL } from 'https://jslib.k6.io/url/1.0.0/index.js'
+import http from 'k6/http'
+import type { Params, Response } from 'k6/http'
+import type { GetItemById200 } from './simpleAPI.schemas'
+
+/**
+ * This is the base client to use for interacting with the API.
+ */
+export class SimpleAPIClient {
+  private cleanBaseUrl: string
+  private commonRequestParameters: Params
+
+  constructor(clientOptions: {
+    baseUrl: string
+    commonRequestParameters?: Params
+  }) {
+    this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+  }
+
+  /**
+   * Returns a single item based on the provided ID
+   * @summary Get an item by its ID
+   */
+  getItemById(
+    id: string,
+    requestParameters?: Params
+  ): {
+    response: Response
+    data: GetItemById200
+  } {
+    const url = new URL(this.cleanBaseUrl + `/items/${id}`)
+    const mergedRequestParameters = this._mergeRequestParameters(
+      requestParameters || {},
+      this.commonRequestParameters
+    )
+    const response = http.request(
+      'GET',
+      url.toString(),
+      undefined,
+      mergedRequestParameters
+    )
+    let data
+
+    try {
+      data = response.json()
+    } catch {
+      data = response.body
+    }
+    return {
+      response,
+      data,
+    }
+  }
+
+  /**
+   * Merges the provided request parameters with default parameters for the client.
+   *
+   * @param {Params} requestParameters - The parameters provided specifically for the request
+   * @param {Params} commonRequestParameters - Common parameters for all requests
+   * @returns {Params} - The merged parameters
+   */
+  private _mergeRequestParameters(
+    requestParameters?: Params,
+    commonRequestParameters?: Params
+  ): Params {
+    return {
+      ...commonRequestParameters, // Default to common parameters
+      ...requestParameters, // Override with request-specific parameters
+      headers: {
+        ...(commonRequestParameters?.headers || {}), // Ensure headers are defined
+        ...(requestParameters?.headers || {}),
+      },
+      cookies: {
+        ...(commonRequestParameters?.cookies || {}), // Ensure cookies are defined
+        ...(requestParameters?.cookies || {}),
+      },
+      tags: {
+        ...(commonRequestParameters?.tags || {}), // Ensure tags are defined
+        ...(requestParameters?.tags || {}),
+      },
+    }
+  }
+}

package/examples/get_request_with_path_parameters_schema/tags/default.ts

@@ -0,0 +1,90 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Simple API
+ * An API with a single GET request that takes a path parameter
+ * OpenAPI spec version: 1.0.0
+ */
+import { URL } from 'https://jslib.k6.io/url/1.0.0/index.js'
+import http from 'k6/http'
+import type { Params, Response } from 'k6/http'
+import type { GetItemById200 } from './simpleAPI.schemas'
+
+/**
+ * This is the base client to use for interacting with the API.
+ */
+export class DefaultClient {
+  private cleanBaseUrl: string
+  private commonRequestParameters: Params
+
+  constructor(clientOptions: {
+    baseUrl: string
+    commonRequestParameters?: Params
+  }) {
+    this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+  }
+
+  /**
+   * Returns a single item based on the provided ID
+   * @summary Get an item by its ID
+   */
+  getItemById(
+    id: string,
+    requestParameters?: Params
+  ): {
+    response: Response
+    data: GetItemById200
+  } {
+    const url = new URL(this.cleanBaseUrl + `/items/${id}`)
+    const mergedRequestParameters = this._mergeRequestParameters(
+      requestParameters || {},
+      this.commonRequestParameters
+    )
+    const response = http.request(
+      'GET',
+      url.toString(),
+      undefined,
+      mergedRequestParameters
+    )
+    let data
+
+    try {
+      data = response.json()
+    } catch {
+      data = response.body
+    }
+    return {
+      response,
+      data,
+    }
+  }
+
+  /**
+   * Merges the provided request parameters with default parameters for the client.
+   *
+   * @param {Params} requestParameters - The parameters provided specifically for the request
+   * @param {Params} commonRequestParameters - Common parameters for all requests
+   * @returns {Params} - The merged parameters
+   */
+  private _mergeRequestParameters(
+    requestParameters?: Params,
+    commonRequestParameters?: Params
+  ): Params {
+    return {
+      ...commonRequestParameters, // Default to common parameters
+      ...requestParameters, // Override with request-specific parameters
+      headers: {
+        ...(commonRequestParameters?.headers || {}), // Ensure headers are defined
+        ...(requestParameters?.headers || {}),
+      },
+      cookies: {
+        ...(commonRequestParameters?.cookies || {}), // Ensure cookies are defined
+        ...(requestParameters?.cookies || {}),
+      },
+      tags: {
+        ...(commonRequestParameters?.tags || {}), // Ensure tags are defined
+        ...(requestParameters?.tags || {}),
+      },
+    }
+  }
+}

package/examples/get_request_with_path_parameters_schema/tags/k6-script.sample.ts

@@ -0,0 +1,11 @@
+import { SimpleAPIClient } from './simpleAPI.ts'
+
+const baseUrl = '<BASE_URL>'
+const client = new SimpleAPIClient({ baseUrl })
+
+export default function () {
+  /**
+   * Get an item by its ID
+   */
+  const getItemByIdResponseData = client.getItemById(id)
+}

package/examples/get_request_with_path_parameters_schema/tags/simpleAPI.schemas.ts

@@ -0,0 +1,12 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Simple API
+ * An API with a single GET request that takes a path parameter
+ * OpenAPI spec version: 1.0.0
+ */
+export type GetItemById200 = {
+  description?: string
+  id?: string
+  name?: string
+}

package/examples/headers_schema/single/headerDemoAPI.ts

@@ -0,0 +1,202 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Header Demo API
+ * An API demonstrating the use of headers in different ways
+ * OpenAPI spec version: 1.0.0
+ */
+import { URL } from 'https://jslib.k6.io/url/1.0.0/index.js'
+import http from 'k6/http'
+import type { Params, Response } from 'k6/http'
+export type GetExampleResponseHeaders200 = {
+  status?: string
+}
+
+export type PostExamplePostBody = {
+  data?: string
+}
+
+export type PostExamplePostHeaders = {
+  /**
+   * Bearer token for authorization
+   */
+  Authorization: string
+}
+
+export type GetExampleGet200 = {
+  message?: string
+}
+
+export type GetExampleGetHeaders = {
+  /**
+   * A custom header for this request
+   */
+  'X-Custom-Header'?: string
+}
+
+/**
+ * This is the base client to use for interacting with the API.
+ */
+export class HeaderDemoAPIClient {
+  private cleanBaseUrl: string
+  private commonRequestParameters: Params
+
+  constructor(clientOptions: {
+    baseUrl: string
+    commonRequestParameters?: Params
+  }) {
+    this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+  }
+
+  /**
+   * This GET request demonstrates the use of custom request headers
+   * @summary GET request with headers
+   */
+  getExampleGet(
+    headers?: GetExampleGetHeaders,
+    requestParameters?: Params
+  ): {
+    response: Response
+    data: GetExampleGet200
+  } {
+    const url = new URL(this.cleanBaseUrl + `/example-get`)
+    const mergedRequestParameters = this._mergeRequestParameters(
+      requestParameters || {},
+      this.commonRequestParameters
+    )
+    const response = http.request('GET', url.toString(), undefined, {
+      ...mergedRequestParameters,
+      headers: {
+        // In the schema, headers can be of any type like number but k6 accepts only strings as headers, hence converting all headers to string
+        ...Object.fromEntries(
+          Object.entries(headers || {}).map(([key, value]) => [
+            key,
+            String(value),
+          ])
+        ),
+        ...mergedRequestParameters?.headers,
+      },
+    })
+    let data
+
+    try {
+      data = response.json()
+    } catch {
+      data = response.body
+    }
+    return {
+      response,
+      data,
+    }
+  }
+
+  /**
+   * This POST request uses a security header for authentication
+   * @summary POST request with security headers
+   */
+  postExamplePost(
+    postExamplePostBody: PostExamplePostBody,
+    headers: PostExamplePostHeaders,
+    requestParameters?: Params
+  ): {
+    response: Response
+    data: void
+  } {
+    const url = new URL(this.cleanBaseUrl + `/example-post`)
+    const mergedRequestParameters = this._mergeRequestParameters(
+      requestParameters || {},
+      this.commonRequestParameters
+    )
+    const response = http.request(
+      'POST',
+      url.toString(),
+      JSON.stringify(postExamplePostBody),
+      {
+        ...mergedRequestParameters,
+        headers: {
+          'Content-Type': 'application/json',
+          // In the schema, headers can be of any type like number but k6 accepts only strings as headers, hence converting all headers to string
+          ...Object.fromEntries(
+            Object.entries(headers || {}).map(([key, value]) => [
+              key,
+              String(value),
+            ])
+          ),
+          ...mergedRequestParameters?.headers,
+        },
+      }
+    )
+    let data
+
+    try {
+      data = response.json()
+    } catch {
+      data = response.body
+    }
+    return {
+      response,
+      data,
+    }
+  }
+
+  /**
+   * This GET request returns custom response headers
+   * @summary GET request with response headers only
+   */
+  getExampleResponseHeaders(requestParameters?: Params): {
+    response: Response
+    data: GetExampleResponseHeaders200
+  } {
+    const url = new URL(this.cleanBaseUrl + `/example-response-headers`)
+    const mergedRequestParameters = this._mergeRequestParameters(
+      requestParameters || {},
+      this.commonRequestParameters
+    )
+    const response = http.request(
+      'GET',
+      url.toString(),
+      undefined,
+      mergedRequestParameters
+    )
+    let data
+
+    try {
+      data = response.json()
+    } catch {
+      data = response.body
+    }
+    return {
+      response,
+      data,
+    }
+  }
+
+  /**
+   * Merges the provided request parameters with default parameters for the client.
+   *
+   * @param {Params} requestParameters - The parameters provided specifically for the request
+   * @param {Params} commonRequestParameters - Common parameters for all requests
+   * @returns {Params} - The merged parameters
+   */
+  private _mergeRequestParameters(
+    requestParameters?: Params,
+    commonRequestParameters?: Params
+  ): Params {
+    return {
+      ...commonRequestParameters, // Default to common parameters
+      ...requestParameters, // Override with request-specific parameters
+      headers: {
+        ...(commonRequestParameters?.headers || {}), // Ensure headers are defined
+        ...(requestParameters?.headers || {}),
+      },
+      cookies: {
+        ...(commonRequestParameters?.cookies || {}), // Ensure cookies are defined
+        ...(requestParameters?.cookies || {}),
+      },
+      tags: {
+        ...(commonRequestParameters?.tags || {}), // Ensure tags are defined
+        ...(requestParameters?.tags || {}),
+      },
+    }
+  }
+}

package/examples/headers_schema/{k6-script.sample.ts → single/k6-script.sample.ts}

@@ -1,7 +1,7 @@
-import { createHeaderDemoAPI } from './headerDemoAPI.ts'
+import { HeaderDemoAPIClient } from './headerDemoAPI.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = createHeaderDemoAPI({ baseUrl })
+const client = new HeaderDemoAPIClient({ baseUrl })
 
 export default function () {
   /**

package/examples/headers_schema/split/headerDemoAPI.schemas.ts

@@ -0,0 +1,32 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Header Demo API
+ * An API demonstrating the use of headers in different ways
+ * OpenAPI spec version: 1.0.0
+ */
+export type GetExampleResponseHeaders200 = {
+  status?: string
+}
+
+export type PostExamplePostBody = {
+  data?: string
+}
+
+export type PostExamplePostHeaders = {
+  /**
+   * Bearer token for authorization
+   */
+  Authorization: string
+}
+
+export type GetExampleGet200 = {
+  message?: string
+}
+
+export type GetExampleGetHeaders = {
+  /**
+   * A custom header for this request
+   */
+  'X-Custom-Header'?: string
+}

package/examples/headers_schema/split/headerDemoAPI.ts

@@ -0,0 +1,184 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Header Demo API
+ * An API demonstrating the use of headers in different ways
+ * OpenAPI spec version: 1.0.0
+ */
+import { URL } from 'https://jslib.k6.io/url/1.0.0/index.js'
+import http from 'k6/http'
+import type { Params, Response } from 'k6/http'
+import type {
+  GetExampleGet200,
+  GetExampleGetHeaders,
+  GetExampleResponseHeaders200,
+  PostExamplePostBody,
+  PostExamplePostHeaders,
+} from './headerDemoAPI.schemas'
+
+/**
+ * This is the base client to use for interacting with the API.
+ */
+export class HeaderDemoAPIClient {
+  private cleanBaseUrl: string
+  private commonRequestParameters: Params
+
+  constructor(clientOptions: {
+    baseUrl: string
+    commonRequestParameters?: Params
+  }) {
+    this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+  }
+
+  /**
+   * This GET request demonstrates the use of custom request headers
+   * @summary GET request with headers
+   */
+  getExampleGet(
+    headers?: GetExampleGetHeaders,
+    requestParameters?: Params
+  ): {
+    response: Response
+    data: GetExampleGet200
+  } {
+    const url = new URL(this.cleanBaseUrl + `/example-get`)
+    const mergedRequestParameters = this._mergeRequestParameters(
+      requestParameters || {},
+      this.commonRequestParameters
+    )
+    const response = http.request('GET', url.toString(), undefined, {
+      ...mergedRequestParameters,
+      headers: {
+        // In the schema, headers can be of any type like number but k6 accepts only strings as headers, hence converting all headers to string
+        ...Object.fromEntries(
+          Object.entries(headers || {}).map(([key, value]) => [
+            key,
+            String(value),
+          ])
+        ),
+        ...mergedRequestParameters?.headers,
+      },
+    })
+    let data
+
+    try {
+      data = response.json()
+    } catch {
+      data = response.body
+    }
+    return {
+      response,
+      data,
+    }
+  }
+
+  /**
+   * This POST request uses a security header for authentication
+   * @summary POST request with security headers
+   */
+  postExamplePost(
+    postExamplePostBody: PostExamplePostBody,
+    headers: PostExamplePostHeaders,
+    requestParameters?: Params
+  ): {
+    response: Response
+    data: void
+  } {
+    const url = new URL(this.cleanBaseUrl + `/example-post`)
+    const mergedRequestParameters = this._mergeRequestParameters(
+      requestParameters || {},
+      this.commonRequestParameters
+    )
+    const response = http.request(
+      'POST',
+      url.toString(),
+      JSON.stringify(postExamplePostBody),
+      {
+        ...mergedRequestParameters,
+        headers: {
+          'Content-Type': 'application/json',
+          // In the schema, headers can be of any type like number but k6 accepts only strings as headers, hence converting all headers to string
+          ...Object.fromEntries(
+            Object.entries(headers || {}).map(([key, value]) => [
+              key,
+              String(value),
+            ])
+          ),
+          ...mergedRequestParameters?.headers,
+        },
+      }
+    )
+    let data
+
+    try {
+      data = response.json()
+    } catch {
+      data = response.body
+    }
+    return {
+      response,
+      data,
+    }
+  }
+
+  /**
+   * This GET request returns custom response headers
+   * @summary GET request with response headers only
+   */
+  getExampleResponseHeaders(requestParameters?: Params): {
+    response: Response
+    data: GetExampleResponseHeaders200
+  } {
+    const url = new URL(this.cleanBaseUrl + `/example-response-headers`)
+    const mergedRequestParameters = this._mergeRequestParameters(
+      requestParameters || {},
+      this.commonRequestParameters
+    )
+    const response = http.request(
+      'GET',
+      url.toString(),
+      undefined,
+      mergedRequestParameters
+    )
+    let data
+
+    try {
+      data = response.json()
+    } catch {
+      data = response.body
+    }
+    return {
+      response,
+      data,
+    }
+  }
+
+  /**
+   * Merges the provided request parameters with default parameters for the client.
+   *
+   * @param {Params} requestParameters - The parameters provided specifically for the request
+   * @param {Params} commonRequestParameters - Common parameters for all requests
+   * @returns {Params} - The merged parameters
+   */
+  private _mergeRequestParameters(
+    requestParameters?: Params,
+    commonRequestParameters?: Params
+  ): Params {
+    return {
+      ...commonRequestParameters, // Default to common parameters
+      ...requestParameters, // Override with request-specific parameters
+      headers: {
+        ...(commonRequestParameters?.headers || {}), // Ensure headers are defined
+        ...(requestParameters?.headers || {}),
+      },
+      cookies: {
+        ...(commonRequestParameters?.cookies || {}), // Ensure cookies are defined
+        ...(requestParameters?.cookies || {}),
+      },
+      tags: {
+        ...(commonRequestParameters?.tags || {}), // Ensure tags are defined
+        ...(requestParameters?.tags || {}),
+      },
+    }
+  }
+}

package/examples/headers_schema/split/k6-script.sample.ts

@@ -0,0 +1,25 @@
+import { HeaderDemoAPIClient } from './headerDemoAPI.ts'
+
+const baseUrl = '<BASE_URL>'
+const client = new HeaderDemoAPIClient({ baseUrl })
+
+export default function () {
+  /**
+   * GET request with headers
+   */
+  const getExampleGetResponseData = client.getExampleGet()
+
+  /**
+   * POST request with security headers
+   */
+  const postExamplePostResponseData = client.postExamplePost(
+    postExamplePostBody,
+    headers
+  )
+
+  /**
+   * GET request with response headers only
+   */
+  const getExampleResponseHeadersResponseData =
+    client.getExampleResponseHeaders()
+}