dockerdocker-composeswaggerswagger-uipostgrest

Docker-compose swagger-ui setup which doesn't depend on a particular URL


I want to add swagger-ui to my docker-compose setup. I'm using postgres and postgrest. My setup looks roughly like:

version: '3'
services:

  postgrest:
    image: postgrest/postgrest
    ports:
      - 3000:3000
    links:
      - postgres         

  postgres:
    image: postgres
    ports:
      - 5432:5432
    volumes:
      - "./pgdata:/var/lib/postgresql/data"

  swagger:
    image: swaggerapi/swagger-ui
    expose:
      - 8080
    ports:
      - 8080:8080
    links:
      - postgrest:postgrest
    environment:
      API_URL: http://localhost:3000

This shows me the proper API docs UI when I'm testing locally. When I deploy, http://localhost:3000 isn't serving an OpenAPI definition anymore, and this breaks. I can change API_URL to the remote URL, but then it won't update locally if I'm testing some changes, and that generally seems to defeat the point anyway.

Is there a way to point swagger at "the postgrest running in the same docker compose setup"? Something like:

  swagger:
    ...
    links:
      - postgrest:postgrest
    environment:
      API_URL: http://postgrest:3000

Sometimes docker compose can do magic like this, e.g. in nginx.

Thanks in advance!


Solution

  • Though you set the API_URL in your docker-compose.yml, the actual request to get the spec file is done by the browser I believe.

    So, your browser should be able to resolve that URL, not the swagger-ui container itself.

    Also, since this is the case, you don't really need a remote Swagger UI hosted at all. Just have a separate local container of swagger-ui running and change the URL to the swagger file when needed, in the UI itself.

    UPDATE: Using SWAGGER_JSON

    version: "3"
    services:
      postgrest:
        image: postgrest/postgrest
        ports:
          - 3000:3000
        environment:
          PGRST_DB_URI: postgres://app_user:password@postgres:5432/app_db
          PGRST_DB_SCHEMA: public
          PGRST_DB_ANON_ROLE: app_user
        depends_on:
          - postgres
    
      postgres:
        image: postgres
        ports:
          - 5435:5432
        environment:
          POSTGRES_DB: app_db
          POSTGRES_USER: app_user
          POSTGRES_PASSWORD: password
        volumes:
          - "./pgdata:/var/lib/postgresql/data"
    
      save-swagger:
        image: busybox
        depends_on:
          - postgrest
        volumes:
          - swagger-json:/spec
        command: >
          /bin/sh -c "sleep 15
          && mkdir -p /spec
          && wget -O /spec/swagger.json http://postgrest:3000"
    
      swagger:
        image: swaggerapi/swagger-ui
        expose:
          - 8080
        ports:
          - 8029:8080
        links:
          - postgrest:postgrest
        environment:
          SWAGGER_JSON: /spec/swagger.json
        volumes:
          - swagger-json:/spec
    
    volumes:
      swagger-json:
    

    Do note that using sleep isn't the best approach. You can check out better options like using wait-on / wait-for / wait-for-it

    PS: I have tried wait-for & wait-for-it, but since postgrest has its endpoint available even though the connection to the DB wasn't successful, it was responding with a 503 and both these utils just check for the TCP socket availability, so don't work as expected here.
    wait-on would work since it checks for 2xx on HEAD requests but you would need a container with nodejs, so I stuck with sleep as the simplest example of what has to be done. :)