How to Set http://localhost:8080 for Your Dockerized C# WebAPI Using Docker Compose

---

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---

Understanding the Problem

When you run a Docker container, by default, it listens on a specific port – commonly port 80 for web applications. However, when you want your application to be accessible on a different port on your local machine (like port 8080), you’ll need to configure your Docker Compose file correctly. Misconfigurations can lead to not being able to access your application as expected, which can be frustrating for developers, especially those new to Docker.

Step-by-Step Solution

1. Docker Compose File Configuration

Example Configuration

Below is a sample configuration to help guide you:

[[See Video to Reveal this Text or Code Snippet]]

Explanation of the Configuration

services: This is the section where you define the various components (services) of your application.

webapi: This is the name of your service. You can name it whatever you prefer, but this is illustrative.

build: The context is set to ./api, pointing Dockers to where your Dockerfile and application code reside.

ports: This is where the magic happens. This line tells Docker to map port 80 inside the container to port 8080 on your host machine (your computer).

2. Accessing Your Application

After making the aforementioned changes, run the command:

[[See Video to Reveal this Text or Code Snippet]]

Important Considerations

1. Access to Swagger

If your application is using Swagger for API documentation, be mindful that it is not available by default when a .NET app runs within a Docker container. To enable Swagger access, set the environment variable ASPNETCORE_ENVIRONMENT to Development. This can be done directly in your Docker Compose file under the service definition:

[[See Video to Reveal this Text or Code Snippet]]

2. Testing and Validation

After making these changes, it's a good idea to validate that everything is working as intended:

If set correctly, you should see your API running, or if you have Swagger configured, the Swagger UI should be rendered correctly.

Conclusion

Configuring your Docker container to expose your C# WebAPI on a specific URL can be achieved with just a few simple lines in your Docker Compose file. By mapping the necessary ports and setting the right environment variables, you can streamline your development process and ensure your APIs are easily accessible. With this guide, you’re now well-equipped to tackle similar configurations in your future Docker endeavors. Happy coding!