express-oas-generator/examples/with-jest/README.md

Module to automatically generate OpenAPI (Swagger) specification for existing ExpressJS 4.x REST API applications

# express-oas-generator with jest

Adopted from https://github.com/sarpik/turbo-schedule

## Test it out

```sh
npm i
npm test
```

See the generated openAPI file @ [./path/to/file.json](./path/to/file.json)

Start the server & see the documentation in action:

```sh
npm start
```

& open [localhost:5000/api-docs](http://localhost:5000/api-docs) or [localhost:5000/api-spec](http://localhost:5000/api-spec)

(you can also serve the file yourself wherever you'd like)

## License

MIT © [Kipras Melnikovas](https://github.com/sarpik)