valitydev/swag-payments
14
0
Fork 0
mirror of https://github.com/valitydev/swag-payments.git synced 2024-11-07 09:58:57 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
34 Commits 19 Branches 0 Tags 3.9 MiB
JavaScript 81.9%
HTML 18.1%
be69c45887
Go to file
Artem Ocheredko be69c45887 CAPI-59 Change tags for getting contract by id (#37)
2017-02-06 22:11:28 +03:00
scripts general grammar fixes (#36) 2017-02-06 20:15:39 +03:00
spec CAPI-59 Change tags for getting contract by id (#37) 2017-02-06 22:11:28 +03:00
web ITS-21: Prepare for the release (#31) 2017-02-06 15:09:03 +03:00
.gitignore ITS-21: Prepare for the release (#31) 2017-02-06 15:09:03 +03:00
gulpfile.js ITS-21: Prepare for the release (#31) 2017-02-06 15:09:03 +03:00
LICENSE ITS-21: Prepare for the release (#31) 2017-02-06 15:09:03 +03:00
Makefile CAPI-59 Add npm install step before building (#35) 2017-02-06 17:56:43 +03:00
package.json ITS-21: Prepare for the release (#31) 2017-02-06 15:09:03 +03:00
README.md ITS-21: Drop unrelated parts of the readme (#32) 2017-02-06 15:18:42 +03:00

README.md

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 😄