|
15 | 15 |
|
16 | 16 | - Parses Swagger specs in **JSON** or **YAML** format |
17 | 17 | - Validates against the [Swagger 2.0 schema](https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v2.0/schema.json) or [OpenAPI 3.0 Schema](https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v3.0/schema.json) |
18 | | -- [Resolves](https://apidevtools.com/swagger-parser/docs/swagger-parser.html#resolveapi-options-callback) all `$ref` pointers, including external files and URLs |
19 | | -- Can [bundle](https://apidevtools.com/swagger-parser/docs/swagger-parser.html#bundleapi-options-callback) all your Swagger files into a single file that only has _internal_ `$ref` pointers |
20 | | -- Can [dereference](https://apidevtools.com/swagger-parser/docs/swagger-parser.html#dereferenceapi-options-callback) all `$ref` pointers, giving you a normal JavaScript object that's easy to work with |
| 18 | +- [Resolves](docs/swagger-parser.md#resolveapi-options-callback) all `$ref` pointers, including external files and URLs |
| 19 | +- Can [bundle](docs/swagger-parser.md#bundleapi-options-callback) all your Swagger files into a single file that only has _internal_ `$ref` pointers |
| 20 | +- Can [dereference](docs/swagger-parser.md#dereferenceapi-options-callback) all `$ref` pointers, giving you a normal JavaScript object that's easy to work with |
21 | 21 | - **[Tested](https://github.com/APIDevTools/swagger-parser/actions)** in Node.js and all modern web browsers on Mac, Windows, and Linux |
22 | 22 | - Tested on **[over 1,500 real-world APIs](https://apis.guru/browse-apis/)** from Google, Microsoft, Facebook, Spotify, etc. |
23 | | -- Supports [circular references](https://apidevtools.com/swagger-parser/docs/#circular-refs), nested references, back-references, and cross-references |
| 23 | +- Supports [circular references](docs/README.md#circular-refs), nested references, back-references, and cross-references |
24 | 24 | - Maintains object reference equality — `$ref` pointers to the same value always resolve to the same object instance |
25 | 25 |
|
26 | 26 | ## Related Projects |
|
51 | 51 | } |
52 | 52 | ``` |
53 | 53 |
|
54 | | -For more detailed examples, please see the [API Documentation](https://apidevtools.com/swagger-parser/docs/) |
| 54 | +For more detailed examples, please see the [API Documentation](docs/README.md). |
55 | 55 |
|
56 | 56 | ## Installation |
57 | 57 |
|
@@ -83,7 +83,7 @@ To use Swagger Parser in a browser, you'll need to use a bundling tool such as [ |
83 | 83 |
|
84 | 84 | ## API Documentation |
85 | 85 |
|
86 | | -Full API documentation is available [right here](https://apidevtools.com/swagger-parser/docs/) |
| 86 | +Full API documentation is available [right here](docs/README.md). |
87 | 87 |
|
88 | 88 | ## Security |
89 | 89 |
|
|
0 commit comments