https://github.com/acacode/swagger-walker
NodeJS utility to help work with Swagger Spec
https://github.com/acacode/swagger-walker
Last synced: 4 months ago
JSON representation
NodeJS utility to help work with Swagger Spec
- Host: GitHub
- URL: https://github.com/acacode/swagger-walker
- Owner: acacode
- License: mit
- Created: 2021-02-15T11:42:45.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-02-25T19:39:45.000Z (over 5 years ago)
- Last Synced: 2025-10-04T22:46:19.381Z (9 months ago)
- Language: TypeScript
- Size: 533 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# swagger-walker
NodeJS utility to help work with Swagger Spec
It eats any version and format of Swagger schema and return strict internal Swagger schema representation
## Usage
1. Install
```bash
npm i -D swagger-walker
```
2. Usage
```ts
import { createSwaggerWalker } from "swagger-walker";
// ...somewhere
const walker = await createSwaggerWalker({
path: PATH_TO_YOUR_SWAGGER_SCHEMA, // optional
url: URL_TO_YOUR_SWAGGER_SCHEMA; // optional
spec: JS_OBJECT_SWAGGER_SCHEMA; // optional
})
if (!walker) {
walker.components.schemas.find(/* do something */)
}
```