| Matteo Scandolo | 431781c | 2017-09-06 15:33:07 -0700 | [diff] [blame] | 1 | swagger: swagger_clean swagger_docs swagger_serve_spec |
| 2 | |
| 3 | swagger_docs: |
| 4 | python scripts/swagger_docs.py |
| 5 | |
| 6 | swagger_clean: |
| 7 | rm -rf swagger/specs/* |
| 8 | |
| 9 | swagger_serve_spec: |
| 10 | http-server --cors ./swagger |
| 11 | |
| 12 | # HOW TO |
| 13 | # - load the virtual env (https://guide.opencord.org/xos/dev/local_env.html) |
| 14 | # - run `make` |
| 15 | # - open the browser at `http://127.0.0.1:8080/ui` |
| 16 | # - you'll see the 'core' apis |
| 17 | # - you can see a list of available apis at `http://127.0.0.1:8080/specs/` |
| 18 | # - just replace the swagger file (top bar) with another one to see different APIs (to be improved) |