valitydev/swag-dark-api
14
0
Fork 0
mirror of https://github.com/valitydev/swag-dark-api.git synced 2024-11-06 10:55:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
13 Commits 16 Branches 0 Tags 752 KiB
JavaScript 77.1%
HTML 22.9%
1c1affeead
Go to file
n.pospolita 1c1affeead renaming
2019-05-23 18:23:36 +03:00
build_utils@ea4aa042f4 BJ-467: add questionary 2019-05-23 17:16:53 +03:00
scripts BJ-467: add questionary 2019-05-23 17:16:53 +03:00
spec renaming 2019-05-23 18:23:36 +03:00
web BJ-467: add questionary 2019-05-23 17:16:53 +03:00
.gitignore BJ-467: add questionary 2019-05-23 17:16:53 +03:00
.gitmodules BJ-467: add questionary 2019-05-23 17:16:53 +03:00
gulpfile.js BJ-467: add questionary 2019-05-23 17:16:53 +03:00
Jenkinsfile BJ-467: add questionary 2019-05-23 17:16:53 +03:00
Makefile BJ-467: add questionary 2019-05-23 17:16:53 +03:00
package.json BJ-467: add questionary 2019-05-23 17:16:53 +03:00
pom.xml BJ-467: add questionary 2019-05-23 17:16:53 +03:00
README.md upd 2019-05-23 18:11:37 +03:00
wercker.yml BJ-467: add questionary 2019-05-23 17:16:53 +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.dark.api" --artifact-id "swag-dark-api" --artifact-version "1.0.0" --group-id "com.rbkmoney" --model-package "com.rbkmoney.dark.model" --additional-properties dateLibrary=java8