https://github.com/echelon-solutions/swagger-codegen-router-template

A template for swagger-codegen that generates a Node.js project that validates and routes requests to a url.
https://github.com/echelon-solutions/swagger-codegen-router-template

api nodejs oas openapi swagger swagger-codegen swagger-specification

Last synced: about 2 months ago
JSON representation

A template for swagger-codegen that generates a Node.js project that validates and routes requests to a url.

Host: GitHub
URL: https://github.com/echelon-solutions/swagger-codegen-router-template
Owner: echelon-solutions
Created: 2017-03-06T02:52:34.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2017-03-06T05:14:19.000Z (over 9 years ago)
Last Synced: 2025-06-23T05:03:33.970Z (12 months ago)
Topics: api, nodejs, oas, openapi, swagger, swagger-codegen, swagger-specification
Language: HTML
Size: 7.81 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

README

# swagger-codegen-router-template

A template for swagger-codegen that generates a Node.js project
that validates and routes requests to a url.

## Environment

- Install [Vagrant](https://www.vagrantup.com/)

## Development Workflow

### 1. Clone the repository

```bash
git clone https://github.com/echelon-solutions/swagger-codegen-router-template.git
```

### 2. Add an Open API (Swagger) specification file

```bash
# Change into the repository directory
cd swagger-codegen-router-template

# Add the swagger specification file
cp /swagger.yaml ./src/main/resources/swagger.yaml
```

### 3. Generate the Node.js router API project

```bash
# Bring up the Vagrant build environment
vagrant up

# Login to the environment
vagrant ssh

# Change into the project directory
# Vagrant syncs the /project directory with your host machine
cd /project

# Run Maven to build and output the project
# Output can be found in /project/target/generated-sources/swagger/
mvn clean package
```

## Support

Please reach out to [support@echelon.solutions](mailto:support@echelon.solutions)
with any questions, concerns, or suggestions.

Also, feel free to clone/fork this project and suggest changes and
updates via a "Pull Request".