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
21 Commits 18 Branches 0 Tags 461 KiB
491fa91167
Go to file
Egor Cherniak 491fa91167
Merge pull request #2 from rbkmoney/ft/JD-596/fix-template 
JD-596: Project initial template and structure fixed
2021-09-06 10:39:21 +03:00
build_utils@a7655bc60c WIP. Swagger converted to openApi 3.0 2021-08-31 17:38:25 +03:00
openapi Descriptions restored 2021-09-03 18:15:43 +03:00
plugins Project initial template and structure fixed 2021-09-03 17:50:56 +03:00
web Project initial template and structure fixed 2021-09-03 17:50:56 +03:00
.gitignore Project initial template and structure fixed 2021-09-03 17:50:56 +03:00
.gitmodules WIP. Swagger converted to openApi 3.0 2021-08-31 17:38:25 +03:00
.redocly.yaml Project initial template and structure fixed 2021-09-03 17:50:56 +03:00
Jenkinsfile Project initial template and structure fixed 2021-09-03 17:50:56 +03:00
Makefile Project initial template and structure fixed 2021-09-03 17:50:56 +03:00
package.json Project initial template and structure fixed 2021-09-03 17:50:56 +03:00
pom.xml Project initial template and structure fixed 2021-09-03 17:50:56 +03:00
README.md Readme 2021-09-02 13:10:33 +03:00

README.md

RBKmoney 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://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 😄