mirror of
https://github.com/valitydev/swag-anapi-v2.git
synced 2024-11-06 01:05:17 +00:00
0f6d0dcf02
remove payout |
||
---|---|---|
.github/workflows | ||
openapi | ||
.gitignore | ||
.redocly.yaml | ||
LICENSE | ||
package-lock.json | ||
package.json | ||
pom.xml | ||
README.md | ||
renovate.json |
Vality Analytics API Specification (OpenAPI 3.0)
Working on specification
Install
- Install Node JS
- Clone repo and
cd
- Run
npm install
- Run
Usage
- Run
npm start
- 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>
- Make changes using your favorite editor or
swagger-editor
(look for URL in console output) - 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 andswagger-ui
in parallel - Once you finish with the changes you can run tests using:
npm test
- Share you changes with the rest of the world by pushing to GitHub 😄