docs: update readme

rookie-luochao · Jun 5, 2024 · 1615593 · 1615593
1 parent e50b69b
commit 1615593
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 0 deletions.
diff --git a/README-zh_CN.md b/README-zh_CN.md
@@ -48,6 +48,8 @@
 
 ## 使用方法
 ### CDN接入
+`spec-url` 为 `完整路径`
+
 ```tsx
 <!doctype html>
 <html lang="en">
@@ -61,6 +63,23 @@
   </body>
 </html>
 ```
+
+`spec-url` 为 `路径`
+
+```tsx
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>openAPI UI</title>
+  </head>
+  <body>
+    <div id="openapi-ui-container" spec-url="/openapi.json" theme="dark"></div>
+    <script src="https://cdn.jsdelivr.net/npm/openapi-ui-dist@latest/lib/openapi-ui.umd.js"></script>
+  </body>
+</html>
+```
+
 ### React接入(或者 Vue接入)
 ```tsx
 import { useEffect } from "react";
@@ -84,6 +103,9 @@ export const openapiRoutes = {
 ### Golang后端框架接入
 - [go-openapi-ui](https://github.com/rookie-luochao/go-openapi-ui)
 
+### Nodejs后端框架接入
+- [nodejs-openapi-ui](https://github.com/openapi-ui/nodejs-openapi-ui)
+
 ## 快速开始
 ```bash
 # node version >= 18

diff --git a/README.md b/README.md
@@ -48,6 +48,8 @@ OpenAPI/Swagger UI document, quickly generate mock params and call api, also sim
 
 ## Usage
 ### With CDN
+`spec-url` is `full path`
+
 ```tsx
 <!doctype html>
 <html lang="en">
@@ -61,6 +63,23 @@ OpenAPI/Swagger UI document, quickly generate mock params and call api, also sim
   </body>
 </html>
 ```
+
+`spec-url` is `path`
+
+```tsx
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>openAPI UI</title>
+  </head>
+  <body>
+    <div id="openapi-ui-container" spec-url="/openapi.json" theme="dark"></div>
+    <script src="https://cdn.jsdelivr.net/npm/openapi-ui-dist@latest/lib/openapi-ui.umd.js"></script>
+  </body>
+</html>
+```
+
 ### With React(or With Vue)
 ```tsx
 import { useEffect } from "react";
@@ -84,6 +103,9 @@ export const openapiRoutes = {
 ### With Go Web Framework
 - [go-openapi-ui](https://github.com/rookie-luochao/go-openapi-ui)
 
+### With Nodejs Web Framework
+- [nodejs-openapi-ui](https://github.com/openapi-ui/nodejs-openapi-ui)
+
 ## Quick start
 ```bash
 # node version >= 18