Swagger UI 和 Vercel:JSON 中位置 1 处出现意外标记 <

lbr*_*ile 5 swagger swagger-ui serverless vercel

代码

完整的代码库和文件夹结构可以在GitHub中查看

这是 Swagger 相关路由(必须使其成为独立服务器)

// api/v1.ts

import express = require("express");
import swaggerJSDoc = require("swagger-jsdoc");
import swaggerUi = require("swagger-ui-express");
import packageJSON = require("../package.json");
import path = require("path");

const app = express();
app.use(express.json());
app.use(express.static(path.resolve(__dirname, "../", "public")));

const swaggerSpec = swaggerJSDoc({
  swaggerDefinition: some_spec,
  apis: ["api/*"]
});

const cssOpts = some_css_override;

app.use("/api/v1", swaggerUi.serve, swaggerUi.setup(swaggerSpec, cssOpts));

module.exports = app;
Run Code Online (Sandbox Code Playgroud)

问题

当我运行vercel dev(本地主机:3000/api/v1)时,我按预期看到文档: 本地(vercel 开发)

但是,当我将代码推送到触发vercel build 的分支时,我看到以下内容: 维塞尔构建

检查控制台,我看到:

DevTools failed to load source map: Could not parse content for https://colormaster-1unjfn63b-lbragile.vercel.app/api/v1/swagger-ui-bundle.js.map: Unexpected token < in JSON at position 1

DevTools failed to load source map: Could not parse content for https://colormaster-1unjfn63b-lbragile.vercel.app/api/v1/swagger-ui-standalone-preset.js.map: Unexpected token < in JSON at position 1
Run Code Online (Sandbox Code Playgroud)

尽管他们的回应是200 网络反应

我知道这与 HTML 内容有关JSON.parse(),但不知道如何解决这个问题。有任何想法吗?

Pan*_*ood 4

我面临着与您完全相同的问题,尝试使用 Express 将 Swagger 部署到 Vercel,但没有成功。

我又做了一步,现在我在控制台中看到一个错误:

拒绝应用“https://myurlishre.vercel.app/api-docs/swagger-ui.css”中的样式,因为其 MIME 类型(“text/html”)不是受支持的样式表 MIME 类型,并且严格的 MIME 检查是已启用。

我所做的是添加文件route.ts

import { Router } from 'express';
import LanguageController from './controller/LanguageController';
import WordController from './controller/WordController';

const routes = Router();

routes.get("/word", WordController.find);
routes.get("/word/:wordName/language/:languageId", WordController.findByWordAndLanguage);
routes.post("/word", WordController.create);
routes.get("/language", LanguageController.find);

export default routes;
Run Code Online (Sandbox Code Playgroud)

我的 server.ts 看起来像这样:

import mongoose from 'mongoose';
import routes from './routes';

const express = require("express");

if (process.env.NODE_ENV !== 'production') {
    require('dotenv').config();
}

const app = express();
const cors = require('cors');


mongoose.connect(process.env.MONGODB_URI || "", {
    dbName: "WordsThatIKnowMongoDB"
})
    .then(() => console.debug("Database connected!"))
    .catch(err => { console.debug(err) });

app.use(express.json());
app.use(express.static("/api-docs"));

app.use(cors());
app.use(routes);

const swaggerUi = require('swagger-ui-express');
const swaggerDocument = require('./swagger.json');

routes.use('/api-docs', swaggerUi.serve);
routes.get('/api-docs', swaggerUi.setup(swaggerDocument));


app.listen(5000, () => {
    console.debug("Running on port 5000.");
});

// Export the Express API
module.exports = app;
Run Code Online (Sandbox Code Playgroud)

您将在上面的文件中看到我更改了 app. 到路线。像这样:

routes.use('/api-docs', swaggerUi.serve);
routes.get('/api-docs', swaggerUi.setup(swaggerDocument));
Run Code Online (Sandbox Code Playgroud)

我仍然无法解决这个问题,但也许这个新错误可以帮助您找到解决方案。我也在找那个。

  • 编辑:已经解决了。

这是解决我的问题的代码:

服务器.ts

import path from 'path';
import cors from 'cors';
import bodyParser from 'body-parser';
import mongoose from 'mongoose';
import routes from './routes';

const express = require("express");
const app = express();

const ROOT_FOLDER = path.join(__dirname, '..');
const SRC_FOLDER = path.join(ROOT_FOLDER, 'src');

// parse requests of content-type - application/x-www-form-urlencoded
app.use(bodyParser.urlencoded({ extended: true }));
// parse requests of content-type - application/json
app.use(bodyParser.json());

app.use(cors());
app.use(routes);

if (process.env.NODE_ENV !== 'production') {
    require('dotenv').config();
}

mongoose.connect(process.env.MONGODB_URI || "", {
    dbName: "WordsThatIKnowMongoDB"
})
    .then(() => console.debug("Database connected!"))
    .catch(err => { console.debug(err) });

const swaggerUi = require('swagger-ui-express');
const swaggerDocument = require('./swagger.json');
const options = { customCssUrl: '/public/swagger-ui.css', customSiteTitle: "The Words That I Know API - Swagger" };

app.use('/public', express.static(path.join(SRC_FOLDER, 'public')));
app.use('/', swaggerUi.serve);
app.get('/', swaggerUi.setup(swaggerDocument, options));

app.listen(5000, () => {
    console.debug("Running on port 5000.");
});

export default app;
Run Code Online (Sandbox Code Playgroud)

不要忘记将 Swagger 中的样式放在“/public/swagger-ui.css”中。在里面创建一个public文件夹src并包含一个swagger-ui.css文件。在这里面,过去的招摇风格。您可以inspect在浏览器上使用并转到source选项卡来找到 swagger 样式。在那里你会找到该swagger-ui.css文件;粘贴样式代码后删除注释行。如果您喜欢以简单的方式获取样式代码,请获取此文件。https://github.com/deywersonp/ghibli-50-api/blob/main/src/public/css/swagger-ui.css