Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oas-tools/oas-generator
NodeJS RESTful APIs scaffolding based OpenAPI 3.x specs using oas-tools and express.
https://github.com/oas-tools/oas-generator
api cli express nodejs oas openapi3 rest scaffolding
Last synced: about 2 months ago
JSON representation
NodeJS RESTful APIs scaffolding based OpenAPI 3.x specs using oas-tools and express.
- Host: GitHub
- URL: https://github.com/oas-tools/oas-generator
- Owner: oas-tools
- License: apache-2.0
- Archived: true
- Created: 2018-05-24T07:35:23.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-08-15T00:25:20.000Z (over 2 years ago)
- Last Synced: 2024-09-25T10:42:00.152Z (about 2 months ago)
- Topics: api, cli, express, nodejs, oas, openapi3, rest, scaffolding
- Language: JavaScript
- Homepage:
- Size: 3.36 MB
- Stars: 41
- Watchers: 8
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> **Warning**
>
> This package is now included in [OAS Tools CLI](https://github.com/oas-tools/oas-cli). Check the [docs](https://oas-tools.github.io/docs/cli) for more info.
# oas-generator
[](https://travis-ci.org/isa-group/oas-generator)
[](https://david-dm.org/isa-group/oas-generator)
[](https://codecov.io/gh/isa-group/oas-generator)
[](https://snyk.io/test/npm/oas-generator)
[](https://greenkeeper.io/)
[](https://nodei.co/npm/oas-generator/)
This module provides NodeJS RESTfull APIs scaffolding based OpenAPI 3.x specs using [oas-tools](https://github.com/isa-group/oas-tools) and [express](https://github.com/expressjs/express). It is compatible with servers generated with the swagger-tool suite to help in the transition from pre-existing servers based on 2.x specs.
We have a 2 min. tutorial:
## 1\. Install oas-generator
```bash
npm install oas-generator -g
```
## 2\. Use oas-generator command
### 2.1\. Help
```bash
$ oas-generator --help
Usage: oas-generator
Options:
-n, --projectName Name for the generated folder
-z, --generateZip Indicate whether the generated folder must be deleted after compression
-h, --help output usage information
```
### 2.2 Examples
Generate a NodeJS project: The following command wil create the code of a NodeJS application based on the OpenAPI Spec 3.x `docker-engine.yaml` and place its code in a folder by the name `generatedServer`.
```bash
$ oas-generator specs/docker-engine.yaml -n generatedServer
```
Once the folder is created locate into it. Install dependencies and run it by doing npm start:
```bash
$ cd generatedServer
$ npm start
```
Now your app is running on port 8080.
You can try the url [http://localhost:8080/v1.33/volumes](http://localhost:8080/v1.33/volumes)
In the folder `controllers` there will be a set of js files with the templates for each method specified in the spec that should be completed to have a fully working API.
Happy coding!
## License
Copyright 2018, [ISA Group](http://www.isa.us.es), [University of Sevilla](http://www.us.es)
For technical inquiry please contact to [engineering team](./extra/team.md).
[](http://www.isa.us.es)
Licensed under the **Apache License, Version 2.0** (the "[License](./LICENSE)"); you may not use this file except in compliance with the License. You may obtain a copy of the License at apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.