|
1 | 1 | # Dotnet.Sample.Api |
2 | | -dotnet 5 web api with version, swagger, localization, jwt token based security, etc. |
| 2 | + |
| 3 | +dotnet 5 web api with versioning, swagger, localization, jwt token based security, etc. |
| 4 | + |
| 5 | +[](https://dotnet.microsoft.com/download/dotnet/5.0) |  |  | |
| 6 | +| --- | --- | --- | --- | |
| 7 | + |
| 8 | +--------------------------------------- |
| 9 | + |
| 10 | +## Repository codebase |
| 11 | + |
| 12 | +The repository consists of projects as below: |
| 13 | + |
| 14 | + |
| 15 | +| # |Project Name | Project detail | location| Environment | |
| 16 | +| ---| --- | --- | --- | --- | |
| 17 | +| 1 | Xero.Demo.Api | Dotnet5 WebApi as backend | Api folder | [](https://dotnet.microsoft.com/download/dotnet/5.0)| |
| 18 | +| 2 | Xero.Demo.Api.Tests | Tests for webapi | Api.Test folder | [](https://dotnet.microsoft.com/download/dotnet/5.0)| |
| 19 | + |
| 20 | +### Summary |
| 21 | + |
| 22 | +The overall objective of the applications : |
| 23 | +``` |
| 24 | +> A user can Login and jwt authentication is used |
| 25 | +> Once authorized, user can do "CRUD" operation |
| 26 | +``` |
| 27 | + |
| 28 | +### Setup detail |
| 29 | + |
| 30 | +##### Environment Setup detail |
| 31 | + |
| 32 | +> Download/install |
| 33 | +> 1. [](https://dotnet.microsoft.com/download/dotnet/5.0) to run webapi project |
| 34 | +> |
| 35 | +> 2. [](https://code.visualstudio.com/) to run/debug the applications |
| 36 | +> |
| 37 | +> |
| 38 | +
|
| 39 | +##### Project Setup detail |
| 40 | + |
| 41 | +> 1. Please clone or download the repository from [](https://github.com/AJEETX/Dotnet.Sample.Api) |
| 42 | +> |
| 43 | +> 2. Create a folder and place the downloaded repository |
| 44 | +> 3. Open **Visual Studio Code** and open the newly created folder where the repository is downloaded |
| 45 | +> |
| 46 | +##### (a) To start the backend webapi service |
| 47 | + |
| 48 | +> 1. Within **Visual Studio Code** open a command terminal by pressing the computer keyboard buttons `Control` and `~` |
| 49 | +> |
| 50 | +> 2. Within the terminal, browse to folder location named as **"Api"** |
| 51 | +> |
| 52 | +> 3. Restore the dependencies, type `dotnet restore` on the terminal |
| 53 | +> |
| 54 | +> 4. Run the webapi project, type `dotnet run` on the terminal |
| 55 | +> |
| 56 | +> 5. **Api** [backend service] shall start running on port **5000** |
| 57 | +
|
| 58 | +``` |
| 59 | +For better experience please chrome browser |
| 60 | +``` |
| 61 | + |
| 62 | +##### (b) To run the unit test project |
| 63 | +> 1. Within **Visual Studio Code** Open a new command terminal |
| 64 | +> |
| 65 | +> 2. Within the new terminal, browse to the folder named as **"Api.Test"** |
| 66 | +> |
| 67 | +> 3. To run the tests, type `dotnet test` on the terminal |
| 68 | +
|
| 69 | +### Support or Contact |
| 70 | + |
| 71 | +Having any trouble? Please read out this [documentation](https://github.com/AJEETX/Dotnet.Sample.Api/blob/master/README.md) or [contact](mailto:ajeetkumar@email.com) and to sort it out. |
| 72 | + |
| 73 | + [](http://hits.dwyl.io/ajeetx/Dotnet.Sample.Api/projects/1) | | |
| 74 | + | --- | --- | |
| 75 | + |
| 76 | + |
0 commit comments