:wMerge branch 'main' into develop

Author: Rui Zhu

README.md

@@ -52,6 +52,7 @@ The unit tests can be run through pytest with
 poetry run pytest
 ```
 
+
 ## Building Docs
 
 The API uses the sphinx documentation formation. To build the documentation, first [install sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html).
@@ -62,3 +63,31 @@ Then,
 cd docs
 make build
 ```
+
+## Running
+
+When the API is running, the following pages can be used to play with the endpoint
+
+Visit the redoc page at http://127.0.0.1:8080/redoc
+
+Visit the swagger page at http://127.0.0.1:8080/docs
+
+
+The API can be run locally when developing. To run,
+
+### For local Development
+
+#### Non-Docker
+
+```bash
+poetry install
+poetry run uvicorn kwg_api.main:app --reload --port 80
+```
+
+### With Docker
+
+The API can also be run using the `docker-compose.dev.yaml` file with
+
+```commandline
+docker-compose -f docker-compose.dev.yaml up
+```

kwg_api/main.py

@@ -8,9 +8,9 @@
 from kwg_api.api.node_negotiator import NodeNegotiator
 from kwg_api.lib.prefix_builder import PrefixBuilder
 
-app = FastAPI(title="KnowWhereGraph API", version="1.0.0")
 logging.basicConfig(level=logging.INFO)
-
+app = FastAPI(title="KnowWhereGraph API", version="1.0.0")
+Instrumentator().instrument(app).expose(app)
 
 @app.get(
     "/lod/ontology/{resource_id}",