@postnord/sls-sesam-swagger-generator

1.0.1 • Public • Published

Severless Sesam Swagger Plugin

What is this repository for?

  • To easily manage a 1 big swagger file in to small multiple files
  • Merge and Generate a single swagger from multiple files
  • Serverless plugin you can integrate to your serverless configuration to automatically generate swagger upon packing or deploying

How do I get set up in Severless.yml file?

custom:
  sesamSwaggerConfig:
    rootFile: "./deploy/swagger/swaggerRootFile.json" # the root file path of the swagger
    outputFile: "./deploy/swagger-deploy.json" # the file path of the output swagger file

How do I use it using Serverless command?

$ serverless generate-sesam-swagger -i <filepath of the root file> -o <filepath of the output swagger file>

Library/Dependency was used

  • swagger-merger - This plugin is written on top of this library. You can use this library documentation for guidelines on how to write your own swagger in modular form.

Who do I talk to?

Sesam developers:

Readme

Keywords

none

Package Sidebar

Install

npm i @postnord/sls-sesam-swagger-generator

Weekly Downloads

1

Version

1.0.1

License

ISC

Unpacked Size

5.19 kB

Total Files

3

Last publish

Collaborators

  • cielomuyot.postnord
  • pn_rroble
  • damiant-postnord
  • erikedling
  • adamkillander
  • sculaste
  • bernhardhettman-pn
  • ashwin_postnord
  • fbopdin
  • elrmndo_pn
  • aliaksei.stryi-postnord
  • sang-canencia-npm-pn
  • pn-ost-base
  • retail-team-npm
  • eriklind-pn
  • postnord.aldee_mativo
  • raymund.galapate
  • romeo.obane
  • elias_sidenbladh
  • ncppublicservice
  • oaipostnord
  • pn-jroma
  • pn-foundation-deployer
  • pn-chester
  • pn-akilumanga
  • sabbir-rahman-sakib
  • jkaske-pn
  • pnrutbergphilip
  • pnorbert
  • kheycee.matarlo
  • johankarlsson-pn
  • sesam-publisher
  • vanessa.faith.abordo.postnord
  • avsceriola-pn
  • junlue-pn
  • pnncp-aftersales
  • mipe-pn
  • vbacalso
  • jonas_elfstrom
  • pn-webteam
  • postnord.npm
  • vbrigoli
  • jvalmores
  • vijilgirish
  • frqu300
  • access-login-publisher
  • joakim.hedlund.postnord
  • pn-fipe
  • pn-aronsson
  • m.usman
  • mahadiapn
  • ambots13