当前位置：首页 > 软件库 > Web应用开发 > Web框架 >

koa2-swagger-ui

Swagger UI as Koa v2 middleware

授权协议 MIT License

开发语言 JavaScript

所属分类 Web应用开发、 Web框架

软件类型开源软件

地区不详

投递者逑翰翮

操作系统跨平台

开源组织无

适用人群未知

软件概览

koa2-swagger-ui

Host swagger ui at a given directory from your koa v2 app

Inspired by:

swagger-injector for serving on a specific route
hapi-swaggered-ui for serving files from node_modules using a handlebars driven index.html

install

npm install koa2-swagger-ui --save

config

for more swaggerOptions see swagger-uidefaults:

title: 'swagger', // page title
oauthOptions: {}, // passed to initOAuth
swaggerOptions: { // passed to SwaggerUi()
  dom_id: 'swagger-ui-container',
  url: 'http://petstore.swagger.io/v2/swagger.json', // link to swagger.json
  supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],
  docExpansion: 'none',
  jsonEditor: false,
  defaultModelRendering: 'schema',
  showRequestHeaders: false,
  swaggerVersion: 'x.x.x' // read from package.json,
  validatorUrl: null, // disable swagger-ui validator
},
routePrefix: '/docs', // route where the view is returned
specPrefix: '/docs/spec', // route where the spec is returned
exposeSpec: false, // expose spec file
hideTopbar: false, // hide swagger top bar
favicon: '/favicon.png', // default favicon

example

import Koa from 'koa';
import { koaSwagger } from 'koa2-swagger-ui';

const app = new Koa();

app.use(
  koaSwagger({
    routePrefix: '/swagger', // host at /swagger instead of default /docs
    swaggerOptions: {
      url: 'http://petstore.swagger.io/v2/swagger.json', // example path to json
    },
  }),
);

app.listen(3000);

example with koa-router and yaml source

depends on yamljs to turn your Yaml into a JS object

npm install --save yamljs

const Koa = require('koa');
const Router = require('koa-router');
const yamljs = require('yamljs');
const koaSwagger = require('koa2-swagger-ui');

const router = new Router({ prefix: '/' });

const app = new Koa();
const router = new Router();

// .load loads file from root.
const spec = yamljs.load('./openapi.yaml');

// example 1 using router.use()
router.use(koaSwagger({ swaggerOptions: { spec } }));

// example 2 using more explicit .get()
router.get('/docs', koaSwagger({ routePrefix: false, swaggerOptions: { spec } }));

app.use(router.routes());
app.listen(3000);

使用案例

体验node Koa2中的封装

基于大神的一个已有node服务器（读者难以重现），体验使用Koa2的封装，封装写文件js.writeFile()方法。本文进行过程回顾。使用MacOS。安装node、Koa2 node.js官网：https://nodejs.org/en/download/ 升级npm: sudo npm install npm -g 安装n: npm install -g n 升级node.js版本: n s
node项目自动生成swagger文档

依赖安装由于我的node是koa项目所以需要安装如下依赖包, 如果是express项目将koa2-swagger-ui换成swaggeer-ui-express npm i koa2-swagger-ui swagger-jsdoc -S koa2-swagger-ui 将swagger JSON转为页面，返回至客户端浏览 swagger-jsdoc 在代码中通过注释的形式，生成swagger
SwaggerUi上传文件注释

注意两点： 1. 在PostMapping里加上 headers = "content-type=multipart/form-data" 2. 在MultipartFile前加上 @ApiParam. 例如：@ApiParam(value="上传", required = true) MultipartFile file @ApiOperation(value = "校验服务发布请求Url

koa2-swagger-ui

koa2-swagger-ui

install

config

example

example with koa-router and yaml source

同类工具

相关阅读

相关文章

相关问答

相关文档