-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
A new Readme.md file has been added. It provides an overview of the SimpleWebApi8 project, its features, prerequisites, installation steps, usage guide, contribution guideline, and license detail.
- Loading branch information
Showing
1 changed file
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# SimpleWebApi8 Project | ||
|
||
This is a simple ASP.NET 8.0 web API project implemented with modern practices. | ||
|
||
## Description | ||
|
||
The API has been developed using ASP.NET 8.0 with minimalist programming style. It provides an API interface for managing devices. | ||
|
||
## Features | ||
|
||
- Communication with a PostgreSQL database using Marten, a .NET transactional document database and event store library. | ||
- API documentation using SwaggerUI/OpenAPI for better interface visibility. | ||
- Endpoints for device data management including creating and retrieving devices. | ||
|
||
## Getting Started | ||
|
||
### Prerequisites | ||
|
||
- .NET 8.0 SDK | ||
- PostgreSQL database | ||
|
||
### Installation | ||
|
||
1. Clone the repository to your machine. | ||
2. Update the connection string in the `builder.Configuration.GetConnectionString("Postgres")` line in `Program.cs`. | ||
3. Restore the dependencies: `dotnet restore` | ||
4. Build the project: `dotnet build` | ||
5. Run the project: `dotnet run` | ||
|
||
## Usage | ||
|
||
Visit `localhost:5000/swagger` in your browser to see and test the available API endpoints: | ||
|
||
- `createDevice`: Creates a new device. | ||
- `device/{deviceId:guid}`: Gets the specified device by its GUID. | ||
|
||
## Contributing | ||
|
||
Contributions are welcome. Create a fork, make your changes, and then issue a pull request. | ||
|
||
Remember to maintain the minimalist programming style and include unit tests where applicable. | ||
|
||
## License | ||
|
||
Open for modification and redistribution under MIT License. |