Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnhof/fleek-parser
A centralized parser for versioned parsing of swagger docs in fleek modules
https://github.com/johnhof/fleek-parser
Last synced: 20 days ago
JSON representation
A centralized parser for versioned parsing of swagger docs in fleek modules
- Host: GitHub
- URL: https://github.com/johnhof/fleek-parser
- Owner: johnhof
- License: mit
- Created: 2015-07-22T17:40:10.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-18T05:47:39.000Z (over 7 years ago)
- Last Synced: 2024-10-05T01:41:14.552Z (about 1 month ago)
- Language: JavaScript
- Size: 67.4 KB
- Stars: 0
- Watchers: 2
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fleek Parser
[](https://travis-ci.org/fleekjs/fleek-parser) [](https://github.com/fleekjs/fleek-parser/blob/master/LICENSE) [](https://david-dm.org/fleekjs/fleek-parser) [](https://gitter.im/fleekjs/fleek-parser?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Parser module that parses [swagger documentation](http://swagger.io/) json into a single fully dereferenced object. Acts as the linch pin to the [Fleekjs](https://github.com/fleekjs) environment of micro-utilities.
`$ npm install fleek-parser`
Beyond basic JSON parse:
- Render all `$ref` within the JSON
- Render all `$ref` referring to a separate file - **TODO**
- Merge `allOf` objects
- provide various utilities to access the Swagger document in a non-standard way
## Key
- [Usage](#usage)
- [Basic](#basic)
- [Utilities](#utilities)
- [Reference Material](#reference-material)
- [Swagger](#swagger)
- [Authors](#authors)
## Usage
### Basic
_app.js_
```javascript
var parser = require('fleek-parser');
// parse stringified JSON as json object
var swaggerFile = fs.readFileSync('./path/to/swagger.json')
var swagger = parser.parse(swaggerFile);
// OR
// parse JSON file from path
var swagger = parser.parse("./path/to/swagger.json");
```
_swagger.json_
```JSON
{
"swagger": "2.0",
"info": {
"version": "2.0.0",
"title": "Swagger Petstore",
"contact": {
"name": "Swagger API Team",
"url": "http://swagger.io"
}
},
"host": "petstore.swagger.io",
"basePath": "/api",
"schemes": [
"http"
],
"paths": {
"/pets": {
"get": {
"tags": [ "Pet Operations" ],
"summary": "finds pets in the system",
"responses": {
"200": {
"description": "pet response",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Pet"
}
}
}
}
}
}
},
"definitions": {
"Pet": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"format": "int64"
}
}
}
}
}
```
#### Dereference example
```javascript
console.log(swagger.paths['/pets'].get.responses['200'].schema.items)
// {
// "type": "object",
// "required": [
// "id"
// ],
// "properties": {
// "id": {
// "type": "integer",
// "format": "int64"
// }
// }
// }
```
## Utilities
Additional properties are attached to the result to simplify usage
```javascript
var parser = require('fleek-parser');
var swagger = parser.parse('./swager.json');
console.log(swagger.controllers);
console.log(swagger.routeValidationMap);
console.log(swagger.sanitizedRoutes);
```
## Reference Material
#### Swagger
- [Home](http://swagger.io/)
- [Editor Demo](http://editor.swagger.io/)
- [Documentation](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md)
#### By the authors
- [Hart Engineering](http://engineering.hart.com/)
## Authors
- [John Hofrichter](https://github.com/johnhof)
- [Lan Nguyen](https://github.com/lan-nguyen91)
_Built and maintained with [
](http://hart.com/) by the [Hart](http://hart.com/) team._