使用Swagger生成API文档

Swagger是目前最受欢迎的REST API文档生成工具之一。

本文只介绍KoaSwagger的集成。

安装依赖

安装koa2-swagger-ui

1
npm install koa2-swagger-ui --save

配置

关于Swagger UI配置参考:

集成

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
const Koa = require('koa');
const koaSwagger = require('koa2-swagger-ui');
const app = new Koa();
app.use(
koaSwagger({
routePrefix: '/swagger',
swaggerOptions: {
url: 'http://petstore.swagger.io/v2/swagger.json', // example path to json
},
}),
);
app.listen(5000);

OPTIONS

  • routePrefix, 默认是/docs,访问Swaggerurl
  • swaggerOptionsSwagger UI配置选项。
    • url,指定Swagger API的配置。

配置好之后可以直接通过http://localhost:5000/swagger访问。