Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tarathep/tarathec-tutorial-backend
Example ASP.NET 6 repository continuous integration (CI) pipeline with GitHub Actions to Code, Unit Test, SAST, Build artifact for prepare to deploy applications to Azure Web app.
https://github.com/tarathep/tarathec-tutorial-backend
asp aspnet continuous-integration example github-actions mongodb webapi
Last synced: 10 days ago
JSON representation
Example ASP.NET 6 repository continuous integration (CI) pipeline with GitHub Actions to Code, Unit Test, SAST, Build artifact for prepare to deploy applications to Azure Web app.
- Host: GitHub
- URL: https://github.com/tarathep/tarathec-tutorial-backend
- Owner: tarathep
- License: apache-2.0
- Created: 2022-11-24T08:48:43.000Z (about 2 years ago)
- Default Branch: develop
- Last Pushed: 2023-03-04T00:19:06.000Z (almost 2 years ago)
- Last Synced: 2024-11-16T18:30:08.601Z (2 months ago)
- Topics: asp, aspnet, continuous-integration, example, github-actions, mongodb, webapi
- Language: C#
- Homepage:
- Size: 124 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dotnet Tutorial Backend API
## ASP.NET
ASP.NET is an open source web framework, created by Microsoft, for building modern web apps and services with .NET. ASP.NET is cross platform and runs on Windows, Linux, macOS, and Docker.
more : https://dotnet.microsoft.com/en-us/learn/aspnet/what-is-aspnet
## Init Project
Create solution project
```ps
dotnet new sln -n Tutorial-Api
```
Create ASP.NET Web Api project
```ps
dotnet new webapi -o Api
```
Create XUnit project
```ps
dotnet new xunit -o Xunit.Tests
```
Add projects to solution
```ps
dotnet sln add .\Tutorial.Api\Tutorial.Api.csproj
dotnet sln add .\XUnit.Tests\XUnit.Tests.csproj
```
Add reference project into xunit project
```ps
dotnet add ./XUnit.Tests/XUnit.Tests.csproj reference .\Tutorial.Api\Tutorial.Api.csproj
```
## Init Database(MongoDB)
Add dependency MongoDB Driver into project
```ps
dotnet add package MongoDB.Driver --version 2.18.0
```
Mongoshell
```sh
Install mongo-shell
https://www.mongodb.com/docs/mongodb-shell/install/
> mongod --dbpath
> show dbs
> use tutorialdb
> db.createCollection('tutorials')
> db.tutorials.insertMany([{ "title": "Design Patterns", "description": "", "published": false}])
> db.tutorials.find().pretty()
```
## Run
```ps
dotnet run --project ./Tutorial.Api/
```
Swagger : https://localhost:7272/swagger
https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-run#examples
- GET /api/tutorials
Response
```json
[
{
"id": "63730beabd3cb05f2331be45",
"title": "hello",
"description": "world",
"published": null,
"createdAt": "0001-01-01T00:00:00Z",
"updatedAt": "0001-01-01T00:00:00Z"
},
{
"id": "63732124796b18bc753e9157",
"title": "dotnet",
"description": "microsoft",
"published": null,
"createdAt": "0001-01-01T00:00:00Z",
"updatedAt": "0001-01-01T00:00:00Z"
}
]
```
- GET /api/tutorials/{id}
Response
```json
{
"id": "63730beabd3cb05f2331be45",
"title": "hello",
"description": "world",
"published": null,
"createdAt": "0001-01-01T00:00:00Z",
"updatedAt": "0001-01-01T00:00:00Z"
}
```
- POST /api/tutorials
Request Body
```json
{
"title": "string",
"description": "string",
}
```
Response Body
```json
{
"code": "200",
"message": "Inserted a single document Success"
}
```
- DELETE /api/tutorials
Response Body
```json
{
"code": "200",
"message": "All deleted"
}
```
- DELETE /api/tutorials/{id}
Response Body
```json
{
"code": "200",
"message": "Deleted id 63730beabd3cb05f2331be45"
}
```
- PUT /api/tutorials/{id}
Request Body
```json
{
"id": "63730beabd3cb05f2331be45",
"title": "hello",
"description": "world",
"published": true
}
```
Response Body
```json
{
"code": "200",
"message": "Deleted id 63730beabd3cb05f2331be45"
}
```
## Build
```ps
dotnet build
```
Restore as distinct layers
```ps
dotnet restore
```
Build and publish a release
```ps
dotnet publish -c Release -o out
```
## Unit Tests
Run Coverage
```ps
dotnet test --collect:"XPlat Code Coverage"
```
Add ReportGenerator nuget
```ps
dotnet add package ReportGenerator --version 5.1.10
```
Setup tool ReportGenerator
```ps
dotnet tool install -g dotnet-reportgenerator-globaltool
```
more : https://www.nuget.org/packages/ReportGenerator
## Run report HTML
```ps
reportgenerator -reports:"XUnit.Tests\TestResults\*\coverage.cobertura.xml" -targetdir:"./coveragereport" -reporttypes:Html
```
## Configurations
Environment variables
|Env Name|Value|
|---|---|
|TutorialDatabase__ConnectionString|mongodb://xxxxxxxx|
|TutorialDatabase__DatabaseName|tutorialdb|
|TutorialDatabase__TutorialCollectionName|tutorials|
## Logging integrate with Azure Application Insights
https://learn.microsoft.com/en-us/azure/azure-monitor/app/ilogger#aspnet-core-applications
Add package ApplicationInsights
```ps
dotnet add package Microsoft.ApplicationInsights.AspNetCore --version 2.21.0
```
...