valitydev/swag-payments
14
0
Fork 0
mirror of https://github.com/valitydev/swag-payments.git synced 2024-11-06 09:35:22 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
f30afb5670
swag-payments/README.md
Andrew Mayorov e5596f7476 ITS-21: Drop unrelated parts of the readme (#32)
2017-02-06 15:18:42 +03:00

927 B
Raw Blame History

RBKmoney OpenAPI Specification

Working on specification

Install

  1. Install Node JS
  2. Clone repo and cd
    • Run npm install

Usage

  1. Run npm start
  2. Checkout console output to see where local server is started. You can use all links (except preview) by replacing https://git@github.com:antonlva.github.io/rbkmoney-api-docs.git/ with url from the message: Server started <url>
  3. Make changes using your favorite editor or swagger-editor (look for URL in console output)
  4. All changes are immediately propagated to your local server, moreover all documentation pages will be automagically refreshed in a browser after each change TIP: you can open swagger-editor, documentation and swagger-ui in parallel
  5. Once you finish with the changes you can run tests using: npm test
  6. Share you changes with the rest of the world by pushing to GitHub 😄