File tree Expand file tree Collapse file tree 7 files changed +74
-15
lines changed
docusaurus-plugin-openapi
docusaurus-preset-openapi Expand file tree Collapse file tree 7 files changed +74
-15
lines changed Original file line number Diff line number Diff line change
1
+ ## 0.4.0 (Dec 23, 2021)
2
+
3
+ High level enhancements
4
+
5
+ - Docusaurus beta.14 support
6
+
7
+ ``` js
8
+ // Be sure to update @docusaurus/core:
9
+ " dependencies" : {
10
+ " @docusaurus/core" : " 2.0.0-beta.14" ,
11
+ // ...
12
+ }
13
+ ```
14
+
15
+ - With the release of Docusaurus beta.14 (Thanks @slorber !), we can now support configuration of ` webpack-dev-server ` 's proxy via our ` docusaurus-plugin-proxy ` plugin.
16
+
17
+ This can be useful when you have a separate API backend development server and you want to send API requests on the same domain.
18
+
19
+ With the following, a request to ` /api/users ` will now proxy the request to ` http://localhost:3001/api/users ` :
20
+
21
+ ``` js
22
+ // docusaurus.config.js
23
+
24
+ const config = {
25
+ plugins: [[" docusaurus-plugin-proxy" , { " /api" : " http://localhost:3001" }]],
26
+ // ...
27
+ };
28
+ ```
29
+
30
+ To proxy ` /api/users ` to ` http://localhost:3001/users ` , the path can be rewritten:
31
+
32
+ ``` js
33
+ // docusaurus.config.js
34
+
35
+ const config = {
36
+ plugins: [
37
+ [
38
+ " docusaurus-plugin-proxy" ,
39
+ {
40
+ " /api" : {
41
+ target: " http://localhost:3001" ,
42
+ pathRewrite: { " ^/api" : " " },
43
+ },
44
+ },
45
+ ],
46
+ ],
47
+ // ...
48
+ };
49
+ ```
50
+
51
+ For more config options, see [ devServer.proxy] ( https://webpack.js.org/configuration/dev-server/#devserverproxy ) .
52
+
53
+ - Better yarn 3 support
54
+
55
+ Other enhancements and bug fixes
56
+
57
+ - Bump to beta 14 and fix proxy plugin ([ #120 ] ( https://github.com/cloud-annotations/docusaurus-plugin-openapi/pull/120 ) )
58
+ - Fix dependency resolutions ([ #119 ] ( https://github.com/cloud-annotations/docusaurus-plugin-openapi/pull/119 ) )
59
+
1
60
## 0.3.1 (Dec 21, 2021)
2
61
3
62
High level enhancements
Original file line number Diff line number Diff line change 1
1
{
2
2
"name" : " demo" ,
3
- "version" : " 0.3.1 " ,
3
+ "version" : " 0.4.0 " ,
4
4
"private" : true ,
5
5
"scripts" : {
6
6
"docusaurus" : " docusaurus" ,
18
18
"@mdx-js/react" : " ^1.6.21" ,
19
19
"@svgr/webpack" : " ^5.5.0" ,
20
20
"clsx" : " ^1.1.1" ,
21
- "docusaurus-preset-openapi" : " ^0.3.1 " ,
21
+ "docusaurus-preset-openapi" : " ^0.4.0 " ,
22
22
"file-loader" : " ^6.2.0" ,
23
23
"prism-react-renderer" : " ^1.2.1" ,
24
24
"react" : " ^17.0.1" ,
Original file line number Diff line number Diff line change 1
1
{
2
- "version" : " 0.3.1 " ,
2
+ "version" : " 0.4.0 " ,
3
3
"npmClient" : " yarn" ,
4
4
"useWorkspaces" : true
5
5
}
Original file line number Diff line number Diff line change 1
1
{
2
2
"name" : " docusaurus-plugin-openapi" ,
3
3
"description" : " OpenAPI plugin for Docusaurus." ,
4
- "version" : " 0.3.1 " ,
4
+ "version" : " 0.4.0 " ,
5
5
"license" : " MIT" ,
6
6
"publishConfig" : {
7
7
"access" : " public"
17
17
"@docusaurus/types" : " ^2.0.0-beta.14" ,
18
18
"@types/fs-extra" : " ^9.0.13" ,
19
19
"@types/js-yaml" : " ^4.0.5" ,
20
+ "@types/json-schema" : " ^7.0.9" ,
20
21
"@types/lodash" : " ^4.14.176" ,
21
22
"@types/postman-collection" : " ^3.5.3" ,
22
- "@types/json-schema" : " ^7.0.9" ,
23
23
"utility-types" : " ^3.10.0"
24
24
},
25
25
"dependencies" : {
Original file line number Diff line number Diff line change 1
1
{
2
2
"name" : " docusaurus-plugin-proxy" ,
3
3
"description" : " A dev server proxy for Docusaurus." ,
4
- "version" : " 0.3.1 " ,
4
+ "version" : " 0.4.0 " ,
5
5
"license" : " MIT" ,
6
6
"publishConfig" : {
7
7
"access" : " public"
13
13
"watch" : " tsc --watch"
14
14
},
15
15
"devDependencies" : {
16
- "@types/webpack-dev-server " : " ^4.5.0 " ,
17
- "@docusaurus/ types" : " ^2.0.0-beta.14 "
16
+ "@docusaurus/types " : " ^2.0.0-beta.14 " ,
17
+ "@types/webpack-dev-server " : " ^4.5.0 "
18
18
},
19
19
"engines" : {
20
20
"node" : " >=14"
Original file line number Diff line number Diff line change 1
1
{
2
2
"name" : " docusaurus-preset-openapi" ,
3
3
"description" : " OpenAPI preset for Docusaurus." ,
4
- "version" : " 0.3.1 " ,
4
+ "version" : " 0.4.0 " ,
5
5
"license" : " MIT" ,
6
6
"keywords" : [
7
7
" openapi" ,
29
29
},
30
30
"dependencies" : {
31
31
"@docusaurus/preset-classic" : " ^2.0.0-beta.14" ,
32
- "docusaurus-plugin-openapi" : " ^0.3.1 " ,
33
- "docusaurus-plugin-proxy" : " ^0.3.1 " ,
34
- "docusaurus-theme-openapi" : " ^0.3.1 "
32
+ "docusaurus-plugin-openapi" : " ^0.4.0 " ,
33
+ "docusaurus-plugin-proxy" : " ^0.4.0 " ,
34
+ "docusaurus-theme-openapi" : " ^0.4.0 "
35
35
},
36
36
"peerDependencies" : {
37
37
"react" : " ^16.8.4 || ^17.0.0" ,
Original file line number Diff line number Diff line change 1
1
{
2
2
"name" : " docusaurus-theme-openapi" ,
3
3
"description" : " OpenAPI theme for Docusaurus." ,
4
- "version" : " 0.3.1 " ,
4
+ "version" : " 0.4.0 " ,
5
5
"license" : " MIT" ,
6
6
"publishConfig" : {
7
7
"access" : " public"
29
29
"dependencies" : {
30
30
"@mdx-js/react" : " ^1.6.21" ,
31
31
"@monaco-editor/react" : " ^4.3.1" ,
32
- "monaco-editor" : " ^0.31.1" ,
33
32
"buffer" : " ^6.0.3" ,
34
33
"clsx" : " ^1.1.1" ,
35
- "docusaurus-plugin-openapi" : " ^0.3.1 " ,
34
+ "docusaurus-plugin-openapi" : " ^0.4.0 " ,
36
35
"immer" : " ^9.0.6" ,
37
36
"lodash" : " ^4.17.20" ,
37
+ "monaco-editor" : " ^0.31.1" ,
38
38
"postman-code-generators" : " ^1.0.0" ,
39
39
"postman-collection" : " ^4.1.0" ,
40
40
"prism-react-renderer" : " ^1.2.1" ,
You can’t perform that action at this time.
0 commit comments