valitydev/swag-cabi
14
0
Fork 0
mirror of https://github.com/valitydev/swag-cabi.git synced 2024-11-06 01:45:24 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
1 Commit 7 Branches 0 Tags 545 KiB
JavaScript 52.3%
Makefile 33.7%
HTML 14%
cc0ffcd481
Go to file
PNV cc0ffcd481 Initial
2022-03-18 13:09:10 +03:00
.github/workflows Initial 2022-03-18 13:09:10 +03:00
scripts Initial 2022-03-18 13:09:10 +03:00
spec Initial 2022-03-18 13:09:10 +03:00
web Initial 2022-03-18 13:09:10 +03:00
.gitignore Initial 2022-03-18 13:09:10 +03:00
.gitmodules Initial 2022-03-18 13:09:10 +03:00
.redocly.yaml Initial 2022-03-18 13:09:10 +03:00
gulpfile.js Initial 2022-03-18 13:09:10 +03:00
Makefile Initial 2022-03-18 13:09:10 +03:00
package-lock.json Initial 2022-03-18 13:09:10 +03:00
package.json Initial 2022-03-18 13:09:10 +03:00
pom.xml Initial 2022-03-18 13:09:10 +03:00
README.md Initial 2022-03-18 13:09:10 +03:00

README.md

CABI 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://github.com/rbkmoney/swag-cabi.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 😄