关于node koa2和express框架搭建swagger
source link: https://blog.51cto.com/u_16174484/6868699
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
主要分为express和koa2两个框架
由于node后端学习,得有一份接口文档,个人不是很喜欢swagger 本文主要在于避坑
一、网上科普文章多、此文主要解决遇到的问题
SwaggerUIBundle is not defined 与 cdnjs.cloudflare.com CDN加载失败
这个原因网上找了很久没有答案 个人目前最好的解决办法 把静态资源拿到本地
先找到node_modules 如果是koa2-swagger-ui或 express-swagger-generator
修改index.html或index.hbs里引入地址 如下图：
express
github.com/swagger-api… koa2上图中引用的这几个文件找不到的 在这里dist里去拿
把这些文件放在public静态资源里 例如
koa2 在app引入public的位置
koaSwagger is not a function
koa2-swagger-ui 高版本才能结构 低版本报错 低版本直接引入
swagger设置端口一定要与项目端口保持一致
简洁版具体配置:一、 express-swagger-generator 配置
cnpm install express-swagger-generator
const expressSwagger = require('express-swagger-generator')(app);
const options = {
swaggerDefinition: {
info: {
description: '管理平台',
title: 'Swagger',
version: '1.0.0',
},
host: 'localhost:3002',
basePath: '/',//请求路径头
produces: [
"application/json",
"application/xml"
],
schemes: ['http', 'https'],
securityDefinitions: {
JWT: {
type: 'apiKey',
in: 'header',
name: 'Authorization',
description: "",
}
}
},
route: {
url: '/doc',
docs: '/swagger.json'
},
basedir: __dirname,
files: ['./routes/*.js']
};
expressSwagger(options);
/**
* @typedef UserJSON
* @property {string} username.required - 请输入用户名 - eg: 1
* @property {string} password.required - 请输入密码 - eg: 1
*/
/**
* @typedef Error
* @property {string} code.required
*/
/**
* 用户登陆
* @route POST /users/login
* @summary 登陆
* @group user - 用户相关API
* @param {UserJSON.model} body.body.required - username&password
* @returns {object} 200 - 成功
* @returns {Error} default - Unexpected error
*/简洁版具体配置:二、koa2-swagger-ui 配置
npm install koa2-swagger-ui
npm install swagger-jsdoc新建文件swagger.js 位置根据自己放
const router = require('koa-router')(); // 引入路由函数
const swaggerJSDoc = require('swagger-jsdoc');
const swaggerDefinition = {
info: {
description: '关于API文档',
version: '1.0.0',
title: 'Koa2_server Swagger',
},
host: 'localhost:4000',
basePath: '/', // Base path (optional), host/basePath
schemes: ['http', 'https'],
securityDefinitions: {
server_auth: {
type: 'oauth2',
description: '登录账号密码鉴权',
tokenUrl: 'http://localhost:4000/image/oauth',
flow: 'password',
scopes: {
token: 'modify pets in your account'
}
},
}
};
const options = {
swaggerDefinition,
// 写有注解的router的存放地址(当你新增swagger时文档里没显示出来的话那么就是这边地址没有加进去)
apis: ['./routes/*.js'] // routes下所有的js文件
};
const swaggerSpec = swaggerJSDoc(options);
// 通过路由获取生成的注解文件
router.get('/swagger.json', async ctx => {
ctx.set('Content-Type', 'application/json');
ctx.body = swaggerSpec;
});
module.exports = router;
// 将页面暴露出去appjs里引入上面js文件，如果报问题一的错误 把这引用地址替换
const swagger = require('./config/swagger')
const { koaSwagger } = require('./public/swagger-ui')//这个地址是出现问题一后 静态文件放的位置
app.use(swagger.routes(), swagger.allowedMethods())
app.use(
koaSwagger({
routePrefix: '/swagger', // 这里配置swagger的访问路径
swaggerOptions: {
url: '/swagger.json', // 这里配置swagger的文档配置URL，也就是说，我们展示的API都是通过这个接口生成的。
},
}),
);再次申明：如需要更详细的配置网上科普帖可以移步 本文主要解决遇到的问题
纯手写不喜勿喷，纯为了避坑，如果对你帮助麻烦点个赞，不明白的地方留言共同学习
Recommend
-
92
前言 因为自己的博客完全的前后端分离写的，在 seo 这一块也没考虑过，于是乎，便开始了本次的SSR之旅 技术栈 vue2 + koa2 + webpack4 + mongodb 因为webpack也已经到了 4.1 的版本了，所以顺带把webpack3迁移到
-
63
koa简单回顾 koa 内部对http请求、响应做了封装，同时提供了强大的中间件机制来方便开发者扩展koa的功能。一个koa版本的hello world如下所示：
-
64
Koa是基于Nodejs的一个后端框架，算是比较常用的，核心思想就是中间件，Koa实现底层逻辑，其余的就需要自己实现，包括：session、数据库操作、文件上传、路由、模板、静态资源访问等 前言 一直以来都是使用
-
42
Koa 就是一种简单好用的 Web 框架。它的特点是优雅、简洁、表达力强、自由度高 1.1 架设 HTTP 服务 只要三行代码，就可以用 Koa 架设一个 HTTP 服务。 co...
-
32
Golang 自动生成swagger 安装 go get -u github.com/swaggo/swag/cmd/swag 在项目下执行 swag init ,会生成docs目录。如果目录存在则会报错。 ...
-
33
Node.js 是一个异步的世界，官方 API 支持的都是 callback 形式的异步编程模型，这 会带来许多问题，例如: callback Koa Koa – 基于 Node.js 平台的下一代 web 开发框...
-
26
前段时间写了一篇 前端vue项目实现mock数据方式 的文章，主要是在vue项目里使用mock数据，数据和项目耦合在一起，不太优雅，作为一个有追求的前端，怎么能容忍这种...
-
16
一杯茶的时间，上手 Koa2 + MySQL 开发 2020-05-22 2020-10-06后端 ，...
-
12
使用node+puppeteer+express搭建截图服务 转载请注明出处 https://www.cnblogs.com/funnyzpc/p/14222807.html 写在之前 一开始我们的...
-
3
自己搭建项目让我们不仅仅关注于开发本身，知其然知其所以然，收获更多…虽然，对于新手来说，我们选择类似于koa-generator之类的脚手架，可以最快的入手koa2或者node项目。但是，自己搭建项目，更加适用于实际开发中前后端分离的定制化业务场景，且能让...
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK