kill-circular

这个包在官方的基础上解除了循环引用。

why?

swagger-parser 官方使用的是 json-schema-parser 来解析的协议。在 json-schema-parser 的 lib/dereference.js 中有如下内容

line 58

if ($Ref.isAllowed$Ref(value, options)) {
  dereferenced = dereference$Ref(value, keyPath, keyPathFromRoot, parents, $refs, options);
  circular = dereferenced.circular;
  obj[key] = dereferenced.value;
}

修改后

if ($Ref.isAllowed$Ref(value, options)) {
  dereferenced = dereference$Ref(value, keyPath, keyPathFromRoot, parents, $refs, options);
  circular = dereferenced.circular;
  obj[key] = circular ? _.cloneDeep(dereferenced.value) : dereferenced.value;
}

注意观察最后一行，官方的写法是如果是循环引用，是自己引用自己，obj[key] === dereferenced.value.items 恒成立。

我的修改，是拷贝了一份副本，避免了重复引用。这个是为了方便后续的 mock 和 api 在 html 中的渲染，大家酌情使用

#############

以下是官方说明

##############

JSON Schema $Ref Parser

Parse, Resolve, and Dereference JSON Schema $ref pointers

The Problem:

You've got a JSON Schema with $ref pointers to other files and/or URLs. Maybe you know all the referenced files ahead of time. Maybe you don't. Maybe some are local files, and others are remote URLs. Maybe they are a mix of JSON and YAML format. Maybe some of the files contain cross-references to each other.

{
  "definitions": {
    "person": {
      // references an external file
      "$ref": "schemas/people/Bruce-Wayne.json"
    },
    "place": {
      // references a sub-schema in an external file
      "$ref": "schemas/places.yaml#/definitions/Gotham-City"
    },
    "thing": {
      // references a URL
      "$ref": "http://wayne-enterprises.com/things/batmobile"
    },
    "color": {
      // references a value in an external file via an internal reference
      "$ref": "#/definitions/thing/properties/colors/black-as-the-night"
    }
  }
}

The Solution:

JSON Schema $Ref Parser is a full JSON Reference and JSON Pointer implementation that crawls even the most complex JSON Schemas and gives you simple, straightforward JavaScript objects.

• Use JSON or YAML schemas — or even a mix of both!
• Supports $ref pointers to external files and URLs, as well as custom sources such as databases
• Can bundle multiple files into a single schema that only has internal $ref pointers
• Can dereference your schema, producing a plain-old JavaScript object that's easy to work with
• Supports circular references, nested references, back-references, and cross-references between files
• Maintains object reference equality — $ref pointers to the same value always resolve to the same object instance
• Tested in Node, io.js, and all major web browsers on Windows, Mac, and Linux

Example

$RefParser.dereference(mySchema, function(err, schema) {
  if (err) {
    console.error(err);
  }
  else {
    // `schema` is just a normal JavaScript object that contains your entire JSON Schema,
    // including referenced files, combined into a single object
    console.log(schema.definitions.person.properties.firstName);
  }
});

Or use Promises syntax instead. The following example is the same as above:

$RefParser.dereference(mySchema)
  .then(function(schema) {
    console.log(schema.definitions.person.properties.firstName);
  })
  .catch(function(err) {
    console.error(err);
  });

For more detailed examples, please see the API Documentation

Installation

Node

Install using npm:

npm install json-schema-ref-parser

Then require it in your code:

var $RefParser = require('json-schema-ref-parser');

Web Browsers

Reference ref-parser.js or ref-parser.min.js in your HTML:

<script src="https://unpkg.com/json-schema-ref-parser/dist/ref-parser.min.js"></script>
<script>
  $RefParser.dereference(mySchema)
    .then(function(schema) {
      console.log(schema.definitions.person.properties.firstName);
    })
    .catch(function(err) {
      console.error(err);
    });
</script>

API Documentation

Full API documentation is available right here

Contributing

I welcome any contributions, enhancements, and bug-fixes. File an issue on GitHub and submit a pull request.

Building/Testing

To build/test the project locally on your computer:

1. Clone this repo git clone https://github.com/APIDevTools/json-schema-ref-parser.git

2. Install dependencies npm install

3. Run the build script npm run build

4. Run the tests npm test

5. Start the local web server npm start (then browse to http://localhost:8080/test/)

License

JSON Schema $Ref Parser is 100% free and open-source, under the MIT license. Use it however you want.

Big Thanks To

Thanks to these awesome companies for their support of Open Source developers ❤