valitydev/swag-analytics
14
0
Fork 0
mirror of https://github.com/valitydev/swag-analytics.git synced 2024-11-06 08:45:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
update/default
swag-analytics/README.md
Andrew Mayorov f30e1f8e93
Clean up specification 
And drop proprietary CI stuff.
2022-03-14 20:08:45 +03:00

954 B
Raw Permalink Blame History

Valitydev Analytics API Specification

Deprecated. See instead https://github.com/valitydev/swag-anapi-v2.

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 upstream url 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 😄