Giter VIP home page Giter VIP logo

javascript-clients's Introduction

Javascript Clients

Auto generated Javascript clients for swagger API

Contribution

This repository is set up to use monorepo so we have all API clients in place with one configuration and release cycle.

New package

  • Create new folder in packages
  • Run npm init in this newly created packaged
  • NOTE: Please prepend each package name with @redhat-cloud-services in order to have all clients under one company
  • Add custom doc (to generate documentation), build (to build your client) and generate:prod (auto generation) to package scripts
  • Add .npmignore - you may want to copy it from other package
  • Add README.md and LICENSE file to your package

If you are using typescript-axios as code generator you should also add tsconfig file to your folder.

Please do not copy your swagger definition file to this repository as that would make it harder to keep in sync. Much better is to reference the openAPI definition directly either from GH repository or from swaggerhub.

IMPORTANT! First release has to be done manually, please include in your pull request that it is initial release. Or include publishConfig in your package.json

{
    "publishConfig": {
        "access": "public"
    }
}

Building all clients

Run these commands from root folder

  • To install all dependencies in all packages run npm run bootstrap
  • To build all packages run npm run generate - this will generete code from swagger files, builds them and generates doc

javascript-clients's People

Contributors

dependabot[bot] avatar hyperkid123 avatar jharting avatar jiridostal avatar karelhala avatar lgalis avatar nacho-bot avatar rvsia avatar tkasparek avatar

Watchers

 avatar  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.