valitydev/swag-anapi-v2
14
0
Fork 0
mirror of https://github.com/valitydev/swag-anapi-v2.git synced 2024-11-06 01:05:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
87 Commits 18 Branches 0 Tags 461 KiB
renovate/dev.vality-library-parent-pom-1.x
Go to file
renovate[bot] 40e8464efa
Update dependency dev.vality:library-parent-pom to v1.0.3
2024-06-27 12:00:56 +00:00
.github/workflows Update actions/checkout action to v4 (#31) 2024-01-09 17:27:40 +07:00
openapi remove payout 2024-06-27 14:25:03 +03:00
.gitignore TD-625: Bump frontend codegen (#28) 2023-06-26 15:04:25 +04:00
.redocly.yaml TD-253: Add frontend codegen (#15) 2022-03-31 18:56:42 +03:00
LICENSE Let's make it opensource 2021-09-10 14:58:59 +03:00
package-lock.json Bump openapi generator 2024-06-26 17:27:09 +03:00
package.json Bump openapi generator 2024-06-26 17:27:09 +03:00
pom.xml Update dependency dev.vality:library-parent-pom to v1.0.3 2024-06-27 12:00:56 +00: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 😄