feat: access to protected api with custom http header #9

Author: vladkens

logo.svg

@@ -41,11 +41,14 @@ yarn add -D apigen-ts
 ### 1. Generate
 
 ```sh
+# From file
+yarn apigen-ts ./openapi.json ./api-client.ts
+
 # From url
 yarn apigen-ts https://petstore3.swagger.io/api/v3/openapi.json ./api-client.ts
 
-# From file
-yarn apigen-ts ./openapi.json ./api-client.ts
+# From protected url
+yarn apigen-ts https://secret-api.example.com ./api-client.ts -H "x-api-key: secret-key"
 ```
 
 Run `yarn apigen-ts --help` for more options. Examples of generated clients [here](./examples/).
@@ -181,6 +184,7 @@ await apigen({
   name: "MyApiClient", // default "ApiClient"
   parseDates: true, // default false
   inlineEnums: false, // default false, use string literal union instead of enum
+  headers: { "x-api-key": "secret-key" }, // Custom HTTP headers to use when fetching schema
   resolveName(ctx, op, proposal) {
     // proposal is [string, string] which represents module.funcName
     if (proposal[0] === "users") return // will use default proposal

readme.md

@@ -27,7 +27,7 @@ const loadSpecs = async () => {
     if (await fs.stat(out).catch(() => false)) continue
 
     try {
-      const doc = await loadSchema(spec.url, false)
+      const doc = await loadSchema({ url: spec.url, upgrade: false })
       await fs.writeFile(out, JSON.stringify(doc, null, 2))
       console.log(`>> loaded ${spec.name} (${i} of ${specs.length})`)
     } catch (err) {

scripts/guru-check.ts

@@ -13,6 +13,7 @@ export type Config = {
   parseDates: boolean
   inlineEnums: boolean
   resolveName?: (ctx: Context, op: OpConfig, proposal: OpName) => OpName | undefined
+  headers: Record<string, string>
 }
 
 export type Context = Config & { doc: Oas3Definition; logTag: string; usedNames: Set<string> }
@@ -25,12 +26,23 @@ export const initCtx = (config?: Partial<Context>): Context => {
     doc: { openapi: "3.1.0" },
     parseDates: false,
     inlineEnums: false,
+    headers: {},
     ...config,
     logTag: "",
     usedNames: new Set(),
   }
 }
 
+const parseHeaders = (items: string[]): Record<string, string> => {
+  const headers: Record<string, string> = {}
+  for (const item of items) {
+    const [key, val] = item.split(":")
+    if (key && val) headers[key.trim()] = val.trim()
+  }
+
+  return headers
+}
+
 export const getCliConfig = () => {
   const argv = cli({
     name,
@@ -39,19 +51,26 @@ export const getCliConfig = () => {
     flags: {
       name: {
         type: String,
-        description: "api class name to export",
+        description: "API class name to export",
         default: "ApiClient",
       },
       parseDates: {
         type: Boolean,
-        description: "parse dates as Date objects",
+        description: "Parse dates as Date objects",
         default: false,
       },
       inlineEnums: {
         type: Boolean,
-        description: "use inline enums instead of enum types",
+        description: "Use inline enums instead of enum types",
         default: false,
       },
+      header: {
+        type: [String],
+        alias: "H",
+        description:
+          'HTTP header as key=value (e.g., -H "x-api-key: your-key"). Used only when generating code.',
+        default: [],
+      },
     },
   })
 
@@ -61,6 +80,7 @@ export const getCliConfig = () => {
     name: argv.flags.name,
     parseDates: argv.flags.parseDates,
     inlineEnums: argv.flags.inlineEnums,
+    headers: parseHeaders(argv.flags.header),
   }
 
   return config

src/config.ts

@@ -1,4 +1,4 @@
-import redocly, { Oas3Definition } from "@redocly/openapi-core"
+import redocly, { BaseResolver, Oas3Definition } from "@redocly/openapi-core"
 import { filterEmpty, filterNullable } from "array-utils-ts"
 import { isObject, lowerFirst, sortBy, uniqBy, upperFirst } from "lodash-es"
 import { convertObj } from "swagger2openapi"
@@ -231,13 +231,29 @@ export const generateAst = async (ctx: Context) => {
   return { modules, types }
 }
 
-export const loadSchema = async (url: string, upgrade = true): Promise<Oas3Definition> => {
+export const loadSchema = async ({
+  url,
+  upgrade = true,
+  headers = {},
+}: {
+  url: string
+  upgrade?: boolean
+  headers?: Record<string, string>
+}): Promise<Oas3Definition> => {
   if (url.startsWith("file://")) url = url.substring(7)
 
   const { bundle } = await redocly.bundle({
     ref: url,
     config: await redocly.createConfig({}),
     removeUnusedComponents: false,
+    externalRefResolver: new BaseResolver({
+      http: {
+        headers: Object.entries(headers).map(([name, value]) => {
+          // https://github.com/isaacs/minimatch?tab=readme-ov-file#noglobstar
+          return { name, value, matches: "**" }
+        }),
+      },
+    }),
   })
 
   if (bundle.parsed.swagger && upgrade) {

src/generator.ts

@@ -7,7 +7,7 @@ import { generateAst, loadSchema } from "./generator"
 import { formatCode, printCode } from "./printer"
 
 export const apigen = async (config: Partial<Config> & Pick<Config, "source" | "output">) => {
-  const doc = await loadSchema(config.source)
+  const doc = await loadSchema({ url: config.source, headers: config.headers })
   const ctx = initCtx({ ...config, doc })
   const { modules, types } = await generateAst(ctx)