mirror of
https://github.com/valitydev/swag-dark-api.git
synced 2024-11-06 10:55:16 +00:00
23 lines
1.3 KiB
Markdown
23 lines
1.3 KiB
Markdown
# swag-dark-api
|
|
|
|
## Working on specification
|
|
### Install
|
|
|
|
1. Install [Node JS](https://nodejs.org/)
|
|
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](#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 :smile:
|
|
|
|
Для генерации java-кода используйте команду
|
|
'mvn package' OR
|
|
`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`
|