Git Product home page Git Product logo

swagger-generator's Introduction

swagger-generator

Usage in pipeline

tbd

Usage locally

Prerequisites

  • Docker

Steps

  • Build image using Dockerfile (e.g. docker_build.sh)
  • Run image with env variables and volumes described below, e.g.:
    • source env/spinner.env
    • docker_run.sh

Example usage in project's package.json: "@closerplatform/spinner": "/Users/.../swagger/build",

Image Env Variables

Name Function Example
YAML_FILE_PATH Path to definitions file, depends on where the volume was mounted /resources/closerAPI.yaml
PROJECT_NAME Name of project, used when naming package.json spinner
PROJECT_VERSION Version of project, used in package.json 1.0.0
SHOULD_PUBLISH

Image volumes

Type Example Function
Required -v $YAML_FILE_DIRECTORY:/resources:ro make directory with definitions file accessible in container
Optional -v $PWD/build:/swagger/build link built output

Generator options

Codegen 3.0

  • npmName
  • npmVersion
  • supportsES6
  • modelPropertyNaming

swagger-generator's People

Contributors

arkadiuszpasek avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.