Skip to content

Commit 65e5804

Browse files
committed
feat: add setupSwaggerUI for express
1 parent ad1b4f8 commit 65e5804

File tree

8 files changed

+222
-917
lines changed

8 files changed

+222
-917
lines changed

docs/guides/getting-started.md

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -336,23 +336,15 @@ app.listen(port, () => {
336336
最后,我们添加生成和提供 OpenAPI 文档的功能:
337337
338338
```typescript
339-
// [!code ++:6]
340-
import {
341-
generateDocument,
342-
generateSwaggerUI,
343-
getSwaggerUIAssetInfo,
344-
validateRequest,
345-
} from "api-morph";
346-
import { validateRequest } from "api-morph/express";
347339
import express from "express";
340+
import { validateRequest } from "api-morph/express"; // [!code --]
341+
import { generateDocument } from "api-morph"; // [!code ++]
342+
import { setupSwaggerUI, validateRequest } from "api-morph/express"; // [!code ++]
348343
import { UpdateUserDto, UpdateUserVo, UserIdDto } from "./schema";
349344

350345
const app = express();
351346

352347
app.use(express.json());
353-
// [!code ++:2]
354-
// 提供 Swagger UI 需要的静态资源
355-
app.use(express.static(getSwaggerUIAssetInfo().assetPath));
356348

357349
/**
358350
* @summary 更新用户信息
@@ -375,7 +367,7 @@ app.put(
375367
},
376368
);
377369

378-
// [!code ++:24]
370+
// [!code ++:18]
379371
// 生成 OpenAPI 文档
380372
const openapi = await generateDocument(
381373
{
@@ -393,13 +385,7 @@ app.get("/openapi.json", (req, res) => {
393385
});
394386

395387
// 提供 Swagger UI 界面
396-
app.get("/swagger-ui", (req, res) => {
397-
res.send(
398-
generateSwaggerUI({
399-
url: "/openapi.json",
400-
}),
401-
);
402-
});
388+
setupSwaggerUI("/swagger-ui", app);
403389

404390
const port = 3000;
405391
app.listen(port, () => {

0 commit comments

Comments
 (0)