mirror of
https://github.com/valitydev/swag-dark-api.git
synced 2024-11-06 02:45:22 +00:00
| .github/workflows | ||
| scripts | ||
| spec | ||
| web | ||
| .gitignore | ||
| .gitmodules | ||
| gulpfile.js | ||
| LICENSE | ||
| openapitools.json | ||
| package-lock.json | ||
| package.json | ||
| pom.xml | ||
| README.md | ||
swag-dark-api
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.
- 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-uiin 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 😄
Пример подключения в проект клиентской зависимости:
<dependency>
<groupId>com.rbkmoney</groupId>
<artifactId>swag-dark-api</artifactId>
<version>1.45-5184fdc-client</version>
</dependency>
Пример подключения в проект серверной зависимости:
<dependency>
<groupId>com.rbkmoney</groupId>
<artifactId>swag-dark-api</artifactId>
<version>1.45-5184fdc-server</version>
</dependency>
Нельзя использовать две зависимости одновременно (из-за одинакового пути в package)