Code Monkey home page Code Monkey logo

step-api-spec's Introduction

step-api-spec

스텝페이 API Spec을 service별, gateway별로 확인하기 위한 서비스

Requirement

  • npm
  • yarn
brew install node
npm install --global yarn

주요 명령어 사용법

  • 전체 실행하기
chmod +x run.sh
./run.sh
  • 서비스 별로 실행하기
npm install
APP_ENV=production yarn fetch
API_SEGMENT=v1 yarn combine
API_SEGMENT=v1 yarn stoplight
API_SPEC_FILE=v1 yarn build
  • APP_ENV
    • develop
    • staging
    • production
  • API_SEGMENT
    • v1
    • public
    • manager
    • customer
    • internal
    • admin
    • payment
  • API_SPEC_FILE
    • v1
    • public
    • manager
    • customer
    • internal
    • admin
    • payment

swagger ui 확인

node ./src/server.mjs
http://localhost:3000/swagger

기타

Spec Validate Skip

  • org.openapitools.codegen.SpecValidationException 날 때 임시 조치
  • package.json에서 build 옵션에 --skip-validate-spec 추가
"build": "openapi-generator-cli generate -i merge/$API_SPEC_FILE.json -g typescript-axios -o ../step-api-sdk --remove-operation-id-prefix --additional-properties=ngVersion=6.1.7,npmName=step-api-sdk,supportsES6=true,npmVersion=1.0.0,withInterfaces=true"

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.