mirror of
https://github.com/valitydev/swag-anapi-v2.git
synced 2024-11-06 09:15:17 +00:00
19 lines
918 B
Markdown
19 lines
918 B
Markdown
# Vality Analytics API Specification (OpenAPI 3.0)
|
|
|
|
## 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://github.com/valitydev/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:
|