{"id":24864951,"url":"https://github.com/rolandhemmer/dotnet-rest-api-example","last_synced_at":"2025-10-15T09:32:14.606Z","repository":{"id":40858561,"uuid":"313314305","full_name":"rolandhemmer/dotnet-rest-api-example","owner":"rolandhemmer","description":"An example of a .NET REST API. Created with love using .NET Core 3.1, postgreSQL and Docker.","archived":false,"fork":false,"pushed_at":"2022-12-08T11:39:11.000Z","size":44,"stargazers_count":7,"open_issues_count":7,"forks_count":5,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-01-31T08:53:35.519Z","etag":null,"topics":["conventional-commits","csharp","docker","docker-compose","documentation","dotnet","dotnet-core","gitflow","postgresql","rest","rest-api"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rolandhemmer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-16T13:39:31.000Z","updated_at":"2024-10-17T20:26:42.000Z","dependencies_parsed_at":"2023-01-25T12:45:49.963Z","dependency_job_id":null,"html_url":"https://github.com/rolandhemmer/dotnet-rest-api-example","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rolandhemmer%2Fdotnet-rest-api-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rolandhemmer%2Fdotnet-rest-api-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rolandhemmer%2Fdotnet-rest-api-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rolandhemmer%2Fdotnet-rest-api-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rolandhemmer","download_url":"https://codeload.github.com/rolandhemmer/dotnet-rest-api-example/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":236600354,"owners_count":19175173,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["conventional-commits","csharp","docker","docker-compose","documentation","dotnet","dotnet-core","gitflow","postgresql","rest","rest-api"],"created_at":"2025-01-31T23:56:45.180Z","updated_at":"2025-10-15T09:32:14.254Z","avatar_url":"https://github.com/rolandhemmer.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# .NET REST API Example\n\nAn example of a .NET REST API (with database)\n\n## Table of contents\n\n1. [Prerequisites](#prerequisites)\n2. [Environment](#environment)  \n   2.1. [Docker](#docker)  \n   2.2. [.NET Core SDK](#net-core-sdk)\n3. [Usage](#usage)\n\n## 1. Prerequisites\n\n- macOS, Linux or Windows 10\n- 🐳 Docker\n- Compatible IDE or editor\n  - [Visual Studio](https://visualstudio.microsoft.com/vs/)\n  - [Visual Studio Code](https://code.visualstudio.com/)\n  - [Rider](https://www.jetbrains.com/rider/)\n  - _hell, even Vim if you want..._\n\n**[⬆ back to top](#table-of-contents)**\n\n## 2. Environment\n\n### 2.1. Docker\n\nThe [official Docker documentation](https://docs.docker.com/install/linux/docker-ce/ubuntu/) is simply wonderful. Follow the steps, and everything should be as smooth as possible.\n\n⚠ **Make sure to read the \"OS requirements\" part first**. Not all Linux distrubtions are properly supported. Also, LTS versions are usually highly recommanded.\n\nOnce ready, [Docker Compose](https://docs.docker.com/compose/install/) is the next step. Please note that even if there's lot of differents installation options, the Python package is often the preferred option (for its ease-of-use and easy upgradability):\n\n```bash\npip3 install docker-compose\n```\n\n⚠ This command might conflit with your existing Python installation. In that case, other installation ways should be preferred.\n\nUse the following commands to make sure everything is correctly installed:\n\n```bash\ndocker --version\ndocker-compose --version\n```\n\n**[⬆ back to top](#table-of-contents)**\n\n#### 2.1.1 Additional Windows configuration\n\nAfter Docker and Docker Compose, a Windows installation might require a little bit more of work: using the [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10).\n\n\u003e The Windows Subsystem for Linux lets developers run a GNU/Linux environment -- including most command-line tools, utilities, and applications -- directly on Windows, unmodified, without the overhead of a virtual machine.\n\nUse the previous link to get started with this truly life-changing Windows feature.\n\nThen, follow these few configuration steps to connect your new Linux terminal to Docker:\n\n- Expose the Docker deamon without TLS:\n- Share your disk drives to Docker:\n- Install Docker on your Linux subsystem (see [2.1. Docker](#docker))\n- Connect your Linux installation to your Windows Docker instance:\n\n```bash\nexport DOCKER_HOST=tcp://localhost:2375\n\n# To avoid entering this line at every shell launch, add it to your .profile, .bashrc or your preferred shell startup configuration.\n```\n\n- Finally, create the Linux file `/etc/wsl.conf` (as sudo), and enter this content:\n\n```bash\n[automount]\nroot = /\noptions = \"metadata\"\n```\n\nThis will change your Windows disk mount point from `/mnt/\u003cdisk_letter\u003e` to `/\u003cdisk_letter\u003e` (i.e: `/mnt/c` to `/c`).\n\nSeveral system reboots might be required for some steps.\n\n**[⬆ back to top](#table-of-contents)**\n\n### 2.2. .NET Core SDK\n\nThe [official .NET Core documentation](https://docs.microsoft.com/en-us/dotnet/core/install/sdk) is also very detailled. Use the radio menu below the title to choose your OS.\n\nUse the following commands to make sure everything is correctly installed:\n\n```bash\ndotnet --version\n```\n\n**[⬆ back to top](#table-of-contents)**\n\n## 3. Usage\n\nThe repository is Docker-based: from a clean installation, simply run `docker-compose up` to build and run the sample API.\n\nDefault port is `8080`.\n\n### 3.1. Run options\n\nDocker compose supports various options and arguments.  \nSee the [compose documentation](https://docs.docker.com/compose/gettingstarted/) for more.\n\n**[⬆ back to top](#table-of-contents)**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frolandhemmer%2Fdotnet-rest-api-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frolandhemmer%2Fdotnet-rest-api-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frolandhemmer%2Fdotnet-rest-api-example/lists"}