Merge pull request #10 from KnowWhereGraph/develop

Release 1.0.0

Author: ckfisher

.gitignore

@@ -1,4 +1,3 @@
 __pycache__/
 .idea/
 .DS_STORE
-docs/

Dockerfile

@@ -1,6 +1,6 @@
 FROM python:3.10
 
-WORKDIR ./kwg-api/
+WORKDIR /app
 
 RUN pip install poetry
 RUN poetry config virtualenvs.create false
@@ -9,5 +9,6 @@ RUN poetry config virtualenvs.create false
 COPY poetry.lock pyproject.toml README.md ./
 # Use no-root because the root code folder hasn't been added yet
 RUN poetry install --no-root --without dev
-COPY kwg_api/ kwg_api/
+COPY . .
+
 CMD ["poetry", "run", "uvicorn", "kwg_api.main:app", "--host", "0.0.0.0", "--port", "8080"]

README.md

@@ -2,6 +2,31 @@
 
 API service for KnowWhereGraph
 
+## Running
+
+The API service is meant to be run under full stack operating conditions. There are several flavors of the API, which correspond to different docker-compose files.
+
+1. local: Uses a local GraphDB deployment
+2. stage: Uses the staging GraphDB deployment
+3. prod: Uses the production GraphDB deployment
+
+### Outside of the Stack
+
+To run the API in a production setting, outside the full stack, deploy with docker using
+
+```bash
+docker-compose -f docker-compose.dev.yaml up
+```
+
+This avoids the inclusion of the service in the `kwg_netowrk`, which is used when doing a full stack deployment.
+
+Visit the redoc page at http://localhost/redoc
+
+Visit the swagger page at http://localhost/docs
+
+Test the redirection with http://localhost/lod/resource/hazard.1183609.5434007
+
+
 ## Features
 
 - Node de-referencing

docker-compose.dev.yaml

@@ -4,10 +4,11 @@ services:
   kwg-api:
     container_name: kwg-api
     build:
-      context: .
+      context: ./kwg-api/
       dockerfile: Dockerfile
+    image: kwg-api
     ports:
-      - '8080:8080'
+      - '80:8080'
     environment:
-      - base_address_http=http://staging.knowwheregraph.org
-      - base_address_https=https://staging.knowwheregraph.org
+      - base_address_http=https://stko-kwg.geog.ucsb.edu
+      - base_address_https=https://stko-kwg.geog.ucsb.edu

docker-compose.local.yaml

@@ -6,10 +6,12 @@ services:
     build:
       context: ./kwg-api/
       dockerfile: Dockerfile
+    image: kwg-api
     ports:
       - '8080:8080'
     environment:
-      - base_address_http=http://staging.knowwheregraph.org
-      - base_address_https=https://staging.knowwheregraph.org
+      - base_address_http=http://localhost
+      - base_address_https=https://localhost
+      - base_browse_address=https://staging.knowwheregraph.org/browse
     networks:
-      - kwg_network
+      - kwg_network

docker-compose.prod.yaml

@@ -6,10 +6,12 @@ services:
     build:
       context: ./kwg-api/
       dockerfile: Dockerfile
+    image: kwg-api
     ports:
       - '8080:8080'
     environment:
-      - base_address_http=http://stko-kwg.geog.ucsb.edu
-      - base_address_https=https://stko-kwg.geog.ucsb.edu
+      - base_address_http=http://kwg-api:8080
+      - base_address_https=https://kwg-api:8080
+      - base_browse_address=https://stko-kwg.geog.ucsb.edu/browse
     networks:
-      - kwg_network
+      - kwg_network

docker-compose.stage.yaml

@@ -6,10 +6,12 @@ services:
     build:
       context: ./kwg-api/
       dockerfile: Dockerfile
+    image: kwg-api
     ports:
       - '8080:8080'
     environment:
-      - base_address_http=http://staging.knowwheregraph.org
-      - base_address_https=https://staging.knowwheregraph.org
+      - base_address_http=http://kwg-api:8080
+      - base_address_https=https://kwg-api:8080
+      - base_browse_address=https://staging.knowwheregraph.org/browse
     networks:
-      - kwg_network
+      - kwg_network

docs/content-negotiation.rst

@@ -1,7 +1,6 @@
 Content Negotiation
 ===================
-One of the Linked Data principles is that data should be retrievable in different formats, depending on
-the 'Accept' header, known as Content Negotiation.
+One of the Linked Data principles is that data should be retrievable in different formats, depending on the 'Accept' header, known as Content Negotiation.
 
 KnowWhereGraphs supports content negotiation for graph nodes through the API.
 

kwg_api/api/node_negotiator.py

@@ -75,11 +75,9 @@ def _redirect_browse(self) -> RedirectResponse:
 
         :return: A response signaling a redirect to a URL
         """
-        browse_url = f"{self.base_address_https}/browse/"
         resource_id_shortened = PrefixBuilder.resolve_prefix(
             self.request_url, self.resource_id
         )
         if not resource_id_shortened:
             resource_id_shortened = self.resource_id
-        print(self.base_address_https)
-        return RedirectResponse(url=f"{browse_url}#{resource_id_shortened}")
+        return RedirectResponse(url=f"{self.base_browse_address}#{resource_id_shortened}")

kwg_api/lib/content_negotiator.py

@@ -18,6 +18,7 @@ def __init__(self, request: Request, resource_id: str):
         """
         self.base_address_http = os.getenv("base_address_http")
         self.base_address_https = os.getenv("base_address_https")
+        self.base_browse_address = os.getenv("base_browse_address")
         accept_header = request.headers.get("accept")
         if not accept_header:
             raise ValueError("Failed to read the request headers")