Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openpotato/openplzapi
Web service for the OpenPLZ API project
https://github.com/openpotato/openplzapi
gemeindeverzeichnis open-data openplzapi postleitzahlen strassenverzeichnis
Last synced: 14 days ago
JSON representation
Web service for the OpenPLZ API project
- Host: GitHub
- URL: https://github.com/openpotato/openplzapi
- Owner: openpotato
- License: agpl-3.0
- Created: 2022-12-09T12:40:14.000Z (about 2 years ago)
- Default Branch: develop
- Last Pushed: 2024-12-16T12:12:59.000Z (about 1 month ago)
- Last Synced: 2024-12-16T13:23:39.253Z (about 1 month ago)
- Topics: gemeindeverzeichnis, open-data, openplzapi, postleitzahlen, strassenverzeichnis
- Language: C#
- Homepage: https://openplzapi.org/swagger/index.html
- Size: 398 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenPLZ API
The service behind OpenPLZ API. Build with [.NET 9](https://dotnet.microsoft.com/).
## Technology stack
+ [PostgreSQL 17](https://www.postgresql.org/) as database
+ [ASP.NET 9](https://dotnet.microsoft.com/apps/aspnet) as web framework
+ [Entity Framework Core 9](https://docs.microsoft.com/ef/) as ORM layer
+ [Swagger UI](https://swagger.io/tools/swagger-ui/) for OpenAPI based documentation
## Getting started
The following instructions show you how to set up a development environment on your computer.
### Prerequisites
+ Set up a local PosgreSQL 17 (or higher) instance.
+ Clone or download this repository.
+ Open the solution file `OpenPlzApi.sln` in Visual Studio 2022.
### Configure the OpenPLZ API CLI
+ Switch to the project `OpenPlzApi.CLI`.
+ Make a copy of the the `appsettings.json` file and name it `appsettings.Development.json`.
+ Exchange the content with the following JSON document and adjust the values to your needs. This configures the root folder for the data file downloads and the database connection.
``` json
"Sources": {
"RootFolderName": "c:\\OpenPlzApi.Downloads"
},
"Database": {
"Server": "localhost",
"Database": "OpenPlzApi",
"Username": "postgres",
"Password": "qwertz"
}
```
### Create and populate the database
+ Build the `OpenPlzApi.CLI` project.
+ Run the `OpenPlzApi.CLI` project with parameter `initdb --import`. This will create and populate the PostgreSQL database.
### Configure the OpenPLZ API WebService
+ Switch to the `OpenPlzApi.WebService`.
+ Make a copy of the the `appsettings.json` file and name it `appsettings.Development.json`.
+ Exchange the content with the following JSON document and adjust the values to your needs. This configures the database connection.
``` json
"Database": {
"Server": "localhost",
"Database": "OpenPlzApi",
"Username": "postgres",
"Password": "qwertz"
}
```
### Build and test the API
+ Build the `OpenPlzApi.WebService` project.
+ Run the `OpenPlzApi.WebService` project and play with the Swagger UI.
## Can I help?
Yes, that would be much appreciated. The best way to help is to post a response via the Issue Tracker and/or submit a Pull Request.