如何使用Swagger 2.0将API文档拆分为多个文件？

Question

根据Swagger 2.0规范，这可能是有可能实现的。我在使用$ref引用PathObject时指向了另一个文件。我们以前可以很好地使用Swagger 1.2实现这一点。但是Swagger-UI似乎无法读取另一个文件中所引用的PathObject。

这部分规范太新了，还不被支持吗？是否有办法将每个“路径”的文档拆分到另一个文件中？

{
    "swagger": "2.0",
    "basePath": "/rest/json",
    "schemes": [
        "http",
        "https"
    ],
    "info": {
        "title": "REST APIs",
        "description": "desc",
        "version": "1.0"
    },
    "paths": {
        "/time": {
            "$ref": "anotherfile.json"
        }
    }
}

- k2k2e6

Answer 1

为了支持多个文件，您的库必须支持解析$ref字段。但我不建议使用未解析引用的方式提供swagger文件，因为我们的swagger定义大约有30-40个文件。通过HTTP/1.1传送这些文件可能会减慢任何阅读应用程序的速度。

由于我们也正在构建JavaScript库，我们已经使用gulp基于nodejs构建了一个构建系统。对于Node包管理器（npm），您可以找到一些支持解析引用以构建一个大的swagger文件的库。

我们的基本文件如下所示（缩短）：

swagger: '2.0'
info:
  version: 2.0.0
  title: App
  description: Example
basePath: /api/2
paths:
  $ref: "routes.json"
definitions:
  example:
    $ref: "schema/example.json"

routes.json 是从我们的路由文件生成的。为此，我们使用一个实现了 swagger-jsdoc 的 gulp 目标，如下所示：

var gulp = require('gulp');
var fs   = require('fs');
var gutil = require('gulp-util');
var swaggerJSDoc = require('swagger-jsdoc');

gulp.task('routes-swagger', [], function (done) {
    var options = {
        swaggerDefinition: {
            info: {
                title: 'Routes only, do not use, only for reference',
                version: '1.0.0',
            },
        },
        apis: ['./routing.php'], // Path to the API docs
    };
    var swaggerSpec = swaggerJSDoc(options);
    fs.writeFile('public/doc/routes.json', JSON.stringify(swaggerSpec.paths, null, "\t"), function (error) {
        if (error) {
            gutil.log(gutil.colors.red(error));
        } else {
            gutil.log(gutil.colors.green("Succesfully generated routes include."));
            done();
        }
    });
});

为了生成Swagger文件，我们使用一个实现SwaggerParser的构建任务，如下所示：

var gulp = require('gulp');
var bootprint = require('bootprint');
var bootprintSwagger = require('bootprint-swagger');
var SwaggerParser = require('swagger-parser');
var gutil = require('gulp-util');
var fs   = require('fs');

gulp.task('swagger', ['routes-swagger'], function () {
    SwaggerParser.bundle('public/doc/swagger.yaml', {
        "cache": {
            "fs": false
        }
    })
    .then(function(api) {
        fs.writeFile('public/doc/swagger.json', JSON.stringify(api, null, "\t"), function (error) {
            if (error) {
                gutil.log(gutil.colors.red(error));
            } else {
                gutil.log("Bundled API %s, Version: %s", gutil.colors.magenta(api.info.title), api.info.version);
            }
        });
    })
    .catch(function(err) {
        gutil.log(gutil.colors.red.bold(err));
    });
});

通过这种实现方式，我们可以维护一个相当大的swagger规范，并且不受特定编程语言或框架实现的限制，因为我们将路径定义在对真实路由定义的注释中。（注意：gulp任务也分成多个文件。）

- Trendfischer

Answer 2

我解决这个问题的方法是使用下面这个包来解决引用问题

https://www.npmjs.com/package/json-schema-ref-parser

这是使用该库生成Swagger UI的代码片段。我在我的Node服务器中使用了Express.js。

import express from 'express';
import * as path from 'path';
import refParser from '@apidevtools/json-schema-ref-parser';
import swaggerUi from 'swagger-ui-express';

const port = 3100;
const app = express();

app.get('/', async (req, res) => {
  res.redirect('/api-docs')
});

app.use(
  '/api-docs',
  async function (req: express.Request, res: express.Response, next: express.NextFunction) {
    const schemaFilePath = path.join(__dirname, 'schema', 'openapi.yml');

    try {
      // Resolve $ref in schema
      const swaggerDocument = await refParser.dereference(schemaFilePath);
      (req as any).swaggerDoc = swaggerDocument;

      next();
    } catch (err) {
      console.error(err);
      next(err);
    }
  },
  swaggerUi.serve,
  swaggerUi.setup()
);

app.listen(port, () => console.log(`Local web server listening on port ${port}!`));

请查看我的Github存储库，以了解它的工作原理

- deerawan

Answer 3

你也可以使用JSON Refs库来解析这样的多文件Swagger规范。

我在这篇博客文章中写过关于它的内容。

还有这个GitHub仓库可以演示所有这些是如何工作的。

- Mohsen

Answer 4

虽然理论上将来可能会实现该功能，但解决方案仍未完全集成到支持工具中，因此现在我强烈建议将其保留在一个文件中。

如果您正在寻找一种管理和导航Swagger定义的方法，我建议使用规范的YAML格式，在其中可以添加注释，这可能会简化大型定义的导航和拆分。

- Ron

---

你能否告知现在是否可以实现？如果可以的话，能否请指明正确的文档/参考实现？ - Phani