refactor: 配置名path重命名为url

BREAKING CHANGE: 配置名path改为url

Author: geekact

README.md

@@ -27,7 +27,7 @@ import { defineConfig } from 'foca-openapi';
 
 export default defineConfig({
   // 可以是本地路径，也可以是远程地址
-  path: 'http://domain.com/openapi.json',
+  url: 'http://domain.com/openapi.json',
 });
 ```
 
@@ -73,12 +73,12 @@ import { defineConfig } from 'foca-openapi';
 
 export default defineConfig([
   {
-    path: 'http://domain.com/openapi_1.json',
+    url: 'http://domain.com/openapi_1.json',
     // 项目名称，必须是唯一的值
     projectName: 'foo',
   },
   {
-    path: 'http://domain.com/openapi_2.json',
+    url: 'http://domain.com/openapi_2.json',
     // 项目名称，必须是唯一的值
     projectName: 'bar',
   },
@@ -110,7 +110,7 @@ import { defineConfig } from 'foca-openapi';
 
 export default defineConfig((env) => {
   return {
-    path:
+    url:
       env === 'production'
         ? 'https://api.com/openapi.json'
         : 'http://localhost:3000/openapi.json',
@@ -120,7 +120,7 @@ export default defineConfig((env) => {
 
 # 参数
 
-### path
+### url
 
 类型：`string`<br>
 

openapi.config.ts

@@ -1,5 +1,5 @@
 import { defineConfig } from './src/define-config';
 
 export default defineConfig({
-  path: './openapi/openapi.json',
+  url: './openapi/openapi.json',
 });

src/bin.ts

@@ -47,7 +47,7 @@ spinner.add({
   title: '获取openapi文档',
   task: async (ctx) => {
     ctx.docs = await Promise.all(
-      ctx.configs.map((config) => pathToOpenapi(config.path, config.onDocumentLoaded)),
+      ctx.configs.map((config) => pathToOpenapi(config.url, config.onDocumentLoaded)),
     );
     await sleep();
   },

src/define-config.ts

@@ -4,7 +4,7 @@ export interface OpenapiClientConfig {
   /**
    * openapi本地或者远程文件，支持格式：`yaml | json`
    */
-  path: string;
+  url: string;
   /**
    * 过滤指定路由前缀的接口
    */

test/lib/filter-tag.test.ts

@@ -11,15 +11,15 @@ test('未指定过滤标签则不处理', () => {
     },
   });
 
-  filterTag(docs, { path: '' });
+  filterTag(docs, { url: '' });
   expect(Object.keys(docs.paths['/'] || {})).toMatchInlineSnapshot(`
     [
       "get",
       "post",
       "put",
     ]
   `);
-  filterTag(docs, { path: '', includeTag: [] });
+  filterTag(docs, { url: '', includeTag: [] });
   expect(Object.keys(docs.paths['/'] || {})).toMatchInlineSnapshot(`
     [
       "get",
@@ -38,7 +38,7 @@ test('未提供标签的接口会被删除', () => {
     },
   });
 
-  filterTag(docs, { path: '', includeTag: 'abc' });
+  filterTag(docs, { url: '', includeTag: 'abc' });
   expect(Object.keys(docs.paths['/'] || {})).toMatchInlineSnapshot(`
     [
       "post",
@@ -57,7 +57,7 @@ test('不符合的标签被删除', () => {
     },
   });
 
-  filterTag(docs, { path: '', includeTag: 'def' });
+  filterTag(docs, { url: '', includeTag: 'def' });
   expect(Object.keys(docs.paths['/'] || {})).toMatchInlineSnapshot(`
     [
       "put",
@@ -77,7 +77,7 @@ test('同时过滤多个标签', () => {
     },
   });
 
-  filterTag(docs, { path: '', includeTag: ['mn', 'def'] });
+  filterTag(docs, { url: '', includeTag: ['mn', 'def'] });
   expect(Object.keys(docs.paths['/'] || {})).toMatchInlineSnapshot(`
     [
       "put",

test/lib/filter-url.test.ts

@@ -10,7 +10,7 @@ test('未指定过滤路由则不处理', () => {
     '/other': {},
   });
 
-  filterUrl(docs, { path: '' });
+  filterUrl(docs, { url: '' });
   expect(Object.keys(docs.paths)).toMatchInlineSnapshot(`
     [
       "/",
@@ -19,7 +19,7 @@ test('未指定过滤路由则不处理', () => {
       "/other",
     ]
   `);
-  filterUrl(docs, { path: '', includeUriPrefix: [] });
+  filterUrl(docs, { url: '', includeUriPrefix: [] });
   expect(Object.keys(docs.paths)).toMatchInlineSnapshot(`
     [
       "/",
@@ -38,7 +38,7 @@ test('不符合前缀的路由被删除', () => {
     '/other': {},
   });
 
-  filterUrl(docs, { path: '', includeUriPrefix: '/test' });
+  filterUrl(docs, { url: '', includeUriPrefix: '/test' });
   expect(Object.keys(docs.paths)).toMatchInlineSnapshot(`
     [
       "/test/a",
@@ -56,7 +56,7 @@ test('同时过滤多个路由', () => {
     '/foo/bar': {},
   });
 
-  filterUrl(docs, { path: '', includeUriPrefix: ['/test', '/foo'] });
+  filterUrl(docs, { url: '', includeUriPrefix: ['/test', '/foo'] });
   expect(Object.keys(docs.paths)).toMatchInlineSnapshot(`
     [
       "/test/a",
@@ -75,7 +75,7 @@ test('支持正则表达式', () => {
     '/foo/bar': {},
   });
 
-  filterUrl(docs, { path: '', includeUriPrefix: [/\/a/] });
+  filterUrl(docs, { url: '', includeUriPrefix: [/\/a/] });
   expect(Object.keys(docs.paths)).toMatchInlineSnapshot(`
     [
       "/test/a",

test/lib/read-config.test.ts

@@ -3,10 +3,8 @@ import { readConfig } from '../../src/lib/read-config';
 
 test('从根目录获取', async () => {
   expect(readConfig()).toMatchInlineSnapshot(`
-    [
-      {
-        "path": "./openapi/openapi.json",
-      },
-    ]
+    {
+      "url": "./openapi/openapi.json",
+    }
   `);
 });