feat: support docs authorization

Author: rookie-luochao

.changeset/good-olives-sip.md

@@ -0,0 +1,5 @@
+---
+'openapi-ts-request': minor
+---
+
+feat: support docs authorization

README-en_US.md

@@ -135,7 +135,7 @@ $ openapi --help
     -i, --input <string>               OpenAPI specification, can be a path, url (required)
     -o, --output <string>              output directory (required)
     --requestLibPath <string>          custom request lib path, for example: "@/request", "node-fetch", default is "axios"
-    --allowedTags <string[]>           generate results from allowed tags
+    --allowedTags <string[]>           generate code from allowed tags
     --requestOptionsType <string>      custom request method options parameter type (default: "{ [key:
                                       string]: unknown }")
     --requestImportStatement <string>  custom request import statement, for example: "const request =
@@ -145,6 +145,7 @@ $ openapi --help
     --isDisplayTypeLabel <boolean>     generate label matching type field (default: false)
     --isGenJsonSchemas <boolean>       generate JSON Schemas (default: false)
     --mockFolder <string>              mock file path
+    --authorization <string>           docs authorization
     --nullable <boolean>               null instead of optional (default: false)
     --isTranslateToEnglishTag <boolean>translate chinese tag name to english tag name (default: false)
     --isCamelCase <boolean>            camelCase naming of controller files and request client (default: true)
@@ -164,13 +165,14 @@ openapi -i ./spec.json -o ./apis
 | schemaPath | yes | string | - | Swagger2/OpenAPI3 URL |
 | serversPath | no | string | './src/apis' | the folder path for the generated results |
 | requestLibPath | no | string | 'axios' | custom request lib path, for example: '@/request', 'node-fetch' |
-| allowedTags | no | string[] | - | generate results from allowed tags |
+| allowedTags | no | string[] | - | generate code from allowed tags |
 | requestOptionsType | no | string | '{ [key: string]: unknown }' | custom request method options parameter type |
 | requestImportStatement | no | string | - | custom request import statement, for example: "const request = require('@/request')" |
 | apiPrefix | no | string | - | custom the prefix of the api path, for example: 'api'(variable), "'api'"(string) |
 | isDisplayTypeLabel | no | boolean | false | generate label matching type field |
 | isGenJsonSchemas | no | boolean | false | generate JSON Schemas |
 | mockFolder | no | string | './mocks' | mock file path |
+| authorization | 否 | string | - | docs authorization |
 | nullable | no | boolean | false | null instead of optional |
 | isTranslateToEnglishTag | no | boolean | false | translate chinese tag name to english tag name |
 | isCamelCase | no | boolean | true | camelCase naming of controller files and request client |

README.md

@@ -135,7 +135,7 @@ $ openapi --help
     -i, --input <string>               OpenAPI specification, can be a path, url (required)
     -o, --output <string>              output directory (required)
     --requestLibPath <string>          custom request lib path, for example: "@/request", "node-fetch", default is "axios"
-    --allowedTags <string[]>           generate results from allowed tags
+    --allowedTags <string[]>           generate code from allowed tags
     --requestOptionsType <string>      custom request method options parameter type (default: "{ [key:
                                       string]: unknown }")
     --requestImportStatement <string>  custom request import statement, for example: "const request =
@@ -145,6 +145,7 @@ $ openapi --help
     --isDisplayTypeLabel <boolean>     generate label matching type field (default: false)
     --isGenJsonSchemas <boolean>       generate JSON Schemas (default: false)
     --mockFolder <string>              mock file path
+    --authorization <string>           docs authorization
     --nullable <boolean>               null instead of optional (default: false)
     --isTranslateToEnglishTag <boolean>translate chinese tag name to english tag name (default: false)
     --isCamelCase <boolean>            camelCase naming of controller files and request client (default: true)
@@ -164,13 +165,14 @@ openapi --i ./spec.json --o ./apis
 | schemaPath | 是 | string | - | Swagger2/OpenAPI3 地址 |
 | serversPath | 否 | string | './src/apis' | 生成结果的文件夹路径 |
 | requestLibPath | 否 | string | 'axios' | 自定义请求方法路径，例如：'@/request'、'node-fetch' |
-| allowedTags | 否 | string[] | - | 根据指定的 tags 生成结果 |
+| allowedTags | 否 | string[] | - | 根据指定的 tags 生成代码 |
 | requestOptionsType | 否 | string | '{ [key: string]: unknown }' | 自定义请求方法 options 参数类型 |
 | requestImportStatement | 否 | string | - | 自定义请求方法表达式，例如："const request = require('@/request')" |
 | apiPrefix | 否 | string | - | api path的前缀，例如：'api'(动态变量), "'api'"(字符串) |
 | isDisplayTypeLabel | 否 | boolean | false | 是否生成 type 对应的label |
 | isGenJsonSchemas | 否 | boolean | false | 是否生成 JSON Schemas |
 | mockFolder | 否 | string | './mocks' | mock文件路径 |
+| authorization | 否 | string | - | 文档权限凭证 |
 | nullable | 否 | boolean | false | 使用 null 代替可选 |
 | isTranslateToEnglishTag | 否 | boolean | false | 将中文 tag 名称翻译成英文 tag 名称 |
 | isCamelCase | 否 | boolean | true | 小驼峰命名文件和请求函数 |

src/bin/openapi.ts

@@ -38,6 +38,7 @@ const params = program
   )
   .option('--isGenJsonSchemas <boolean>', 'generate JSON Schemas', false)
   .option('--mockFolder <string>', 'mock file path')
+  .option('--authorization <string>', 'docs authorization')
   .option('--nullable <boolean>', 'null instead of optional', false)
   .option(
     '--isTranslateToEnglishTag <boolean>',
@@ -78,6 +79,7 @@ async function run() {
         JSON.parse(params.isDisplayTypeLabel as string) === true,
       isGenJsonSchemas: JSON.parse(params.isGenJsonSchemas as string) === true,
       mockFolder: params.mockFolder as string,
+      authorization: params.authorization as string,
       nullable: JSON.parse(params.nullable as string) === true,
       isTranslateToEnglishTag:
         JSON.parse(params.isTranslateToEnglishTag as string) === true,

src/index.ts

@@ -75,6 +75,10 @@ export type GenerateServiceProps = {
    * mock目录
    */
   mockFolder?: string;
+  /**
+   * 文档权限凭证
+   */
+  authorization?: string;
   /**
    * 默认为false，true时使用null代替可选值
    */
@@ -171,14 +175,18 @@ export async function generateService({
   schemaPath,
   mockFolder,
   allowedTags,
+  authorization,
   isTranslateToEnglishTag,
   ...rest
 }: GenerateServiceProps) {
   if (!schemaPath) {
     return;
   }
 
-  const openAPI = (await getOpenAPIConfig(schemaPath)) as OpenAPIObject;
+  const openAPI = (await getOpenAPIConfig(
+    schemaPath,
+    authorization
+  )) as OpenAPIObject;
 
   if (isEmpty(openAPI)) {
     return;

src/util.ts

@@ -23,7 +23,7 @@ export const getImportStatement = (requestLibPath: string) => {
   return `import request from 'axios';`;
 };
 
-async function getSchema(schemaPath: string) {
+async function getSchema(schemaPath: string, authorization?: string) {
   if (schemaPath.startsWith('http')) {
     const isHttps = schemaPath.startsWith('https:');
     const protocol = isHttps ? https : http;
@@ -34,7 +34,10 @@ async function getSchema(schemaPath: string) {
       });
       const config = isHttps ? { httpsAgent: agent } : { httpAgent: agent };
       const json = await axios
-        .get(schemaPath, config)
+        .get(schemaPath, {
+          ...config,
+          headers: { authorization },
+        })
         .then((res) => res.data as OpenAPI.Document);
 
       return json;
@@ -90,8 +93,11 @@ function converterSwaggerToOpenApi(swagger: OpenAPI.Document) {
   });
 }
 
-export const getOpenAPIConfig = async (schemaPath: string) => {
-  const schema = await getSchema(schemaPath);
+export const getOpenAPIConfig = async (
+  schemaPath: string,
+  authorization?: string
+) => {
+  const schema = await getSchema(schemaPath, authorization);
 
   if (!schema) {
     return;