swagger - 如何使用 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"
        }
    }
}

Answer 1

要支持多个文件，您的库必须支持取消引用 $ref 字段。但我不建议交付带有未解析引用的 swagger 文件。我们的 swagger 定义有大约 30-40 个文件。通过 HTTP/1.1 传送它们可能会降低任何阅读应用程序的速度。

因为我们也在构建 javascript 库，所以我们已经有了一个使用 gulp 的基于 nodejs 的构建系统。对于节点包管理器 (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 是从我们的路由文件生成的。为此，我们使用 gulp 目标实现 swagger-jsdoc像这样:

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 任务也分为多个文件。)