Skip to content

Commit 70a6e69

Browse files
committed
Update exposed endpoints
1 parent 27e1818 commit 70a6e69

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,11 @@ PYTHONPATH=stub python3 init.py
3636
python3 init.py
3737
```
3838

39-
The legacy API and frontend application is available at `localhost:5000`.
39+
Once started, the backend will expose a number of endpoints:
4040

41-
The new API is at `localhost:5000/v2`, while the new application is served at `localhost:5000/vue` (assuming the [vue-app](https://github.com/coderbotorg/vue-app) build is placed in the `dist/` folder).
42-
43-
To see the dynamic documentation of the new API, clone the [swagger-ui](https://github.com/coderbotorg/swagger-ui) repository inside the `coderbot/` folder and it'll be live at `localhost:5000/v2/ui/index.html`.
41+
- Legacy API: [localhost:5000/](http://localhost:5000/);
42+
- Legacy JQuery web application: [localhost:5000:/old](http://localhost:5000/old);
43+
- API v2: [localhost:5000/v2](http://localhost:5000/v2);
44+
- New Vue web application: [localhost:5000/](http://localhost:5000/) (assuming the [vue-app](https://github.com/coderbotorg/vue-app) build is placed in the `dist/` folder);
45+
- Swagger UI dynamic documentation of the API v2: [localhost:5000:/v2/ui/index.html](http://localhost:5000/v2/ui/index.html) (once you cloned the [swagger-ui](https://github.com/coderbotorg/swagger-ui) repository inside the backend folder.
4446

0 commit comments

Comments
 (0)