valitydev/swag-anapi-v2
14
0
Fork 0
mirror of https://github.com/valitydev/swag-anapi-v2.git synced 2024-11-06 09:15:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
67 Commits 18 Branches 0 Tags 461 KiB
69e1a8df30
Go to file
undefined 69e1a8df30 🔄 Created local '.github/settings.yml' from remote '.github/settings.yml'
2022-03-30 01:49:48 +00:00
.github 🔄 Created local '.github/settings.yml' from remote '.github/settings.yml' 2022-03-30 01:49:48 +00:00
openapi Build impl + renovate + actualization 2022-01-24 14:29:19 +03:00
plugins Project initial template and structure fixed 2021-09-03 17:50:56 +03:00
web Build impl + renovate + actualization 2022-01-24 14:29:19 +03:00
.gitignore Fix build 2022-01-24 14:36:44 +03:00
.redocly.yaml Project initial template and structure fixed 2021-09-03 17:50:56 +03:00
LICENSE Let's make it opensource 2021-09-10 14:58:59 +03:00
package-lock.json Fix build 2022-01-24 14:36:44 +03:00
package.json Build impl + renovate + actualization 2022-01-24 14:29:19 +03:00
pom.xml Build upd 2022-01-24 15:40:36 +03:00
README.md Build impl + renovate + actualization 2022-01-24 14:29:19 +03:00
renovate.json Update renovate config 2022-02-21 13:53:48 +03:00

README.md

Vality Analytics API Specification (OpenAPI 3.0)

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/valitydev/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 😄