valitydev/swag-dark-api
14
0
Fork 0
mirror of https://github.com/valitydev/swag-dark-api.git synced 2024-11-06 02:45:22 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
43 Commits 16 Branches 0 Tags 752 KiB
JavaScript 77.1%
HTML 22.9%
d5a5522c43
Go to file
Rinat Arsaev d5a5522c43 fix validation errors (#15)
2019-07-04 19:19:31 +03:00
build_utils@ea4aa042f4 build utils 2019-05-22 18:57:55 +03:00
scripts init copy from yandex-api 2019-05-22 18:52:25 +03:00
spec fix validation errors (#15) 2019-07-04 19:19:31 +03:00
web models 2019-06-24 15:51:53 +03:00
.gitignore init copy from yandex-api 2019-05-22 18:52:25 +03:00
.gitmodules init copy from yandex-api 2019-05-22 18:52:25 +03:00
gulpfile.js models 2019-06-24 15:51:53 +03:00
Jenkinsfile init copy from yandex-api 2019-05-22 18:52:25 +03:00
Makefile init copy from yandex-api 2019-05-22 18:52:25 +03:00
package.json init copy from yandex-api 2019-05-22 18:52:25 +03:00
pom.xml refactored package name 2019-05-23 18:59:44 +03:00
README.md fixed generated path (+ shopID) 2019-06-10 15:36:52 +03:00
wercker.yml Revert "add submodules (#12)" (#13) 2019-07-04 18:59:51 +03:00

README.md

swag-dark-api

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 😄

Для генерации клиентского java-кода используйте команду npm run-script build && swagger-codegen generate -i web_deploy/swagger.json -l java -o ./java --api-package "com.rbkmoney.swag.dark_api.client" --artifact-id "swag-dark-api" --artifact-version "1.1.0" --group-id "com.rbkmoney" --model-package "com.rbkmoney.swag.dark_api.model" --library resttemplate --additional-properties dateLibrary=java8

Для генерации серверного java-кода используйте команду mvn package