MakingSense / WebApiCore-Seed

MIT License
2 stars 5 forks source link

WebapiCore-seed Build Status

Prerequisites

.NET Core SDK

A text processor / gui

Download them

Getting started

For Windows users with Visual Studio

  1. Open WebApiCoreSeed.sln located on the folder where the repository was downloaded

  2. If the Seed.Api project is not selected as startup, just right click it and then click on Set as StartUp Project

    set as startup

  3. Now you just have to run it, pressing F5 or the run button the top, if you use iisexpress configuration your app will be attached to the port :4992, if you use the executable, the port used will be :4993

    Run it

  4. Now you just can open your favorite browser and navigate to localhost:$Port/swagger to see all the configured endpoints

For users using vs code / console

  1. Open the folder in vs code

  2. Make sure you are in WebApiCore-Seed folder

  3. Run dotnet restore on the integrated terminal, to install the dependencies of the project

  4. Go to Seed.Api folder using cd command

  5. Run dotnet run and wait, this would host the application on the :4993 port

  6. Finally you can open a browser and navigate localhost:4993/swagger to check all the available endpoints

What uses

Technology Description
Asp .Net Web Api Core Core framework
Entity Framework Data access library
Net Core DI Integrated dependecy injection library
Xunit Testing framework
SwaggerUI UI that document and exposes the API endpoints
Swashbuckle Documentation generator for Swagger