Skip to content

Commit 9a0badc

Browse files
author
Sergey Tregub
committed
Update the doc
1 parent 335c4ec commit 9a0badc

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# ASP.Net Core RESTful Service Template
22

3-
The repository contains a ready to use preconfigured project template for MS Visual Studio 2017 and 2019 to create fully functional production-ready cross-platform RESTful services based on ASP.Net Core 2.1.
3+
The repository contains a ready to use preconfigured project template for MS Visual Studio 2017 and 2019 to create fully functional production-ready cross-platform RESTful services based on ASP.Net Core 3.1.
44

5-
> Note! If you are looking for classic ASP.Net services with WebAPI2 and other stuff like that, please, check out a project [
5+
> Note 1. ASP.NET Core 3.0 has many breaking changes against version 2.2. If you want to use v2.2 or earlier, please, check out one of the previous releases, starting from [version 1.3](https://github.com/drwatson1/AspNet-Core-REST-Service/releases/tag/v1.3) or earlier.
6+
>
7+
> Note 2. If you are looking for classic ASP.Net services with WebAPI2 and other stuff like that, please, check out a project [
68
ASP.Net WebApi2 Application with OWIN](https://github.com/drwatson1/AspNet-WebApi).
79

810
This template is intended to provide you an almost all that you need for creating RESTful services. The project doesn't contain any UI stuff, like React or Angular libraries, npm, Razor views, as well as any problem domain specific things like EnityFramework, some "right" or "neat" project structure or even a number of projects, each for the specific purpose (for example, service itself, domain logic, data access, testing and so on) as it does some other templates. There are too many areas where ASP.Net Core services can be used, so it can hardly be offered anything related to domain areas to fit all of these project types.
@@ -18,6 +20,20 @@ However, some things must be implemented or configured in almost each of the pro
1820
- Ability to use environment variables in configuration options and support for '.env' files to easy switching between different environments (thanks to DotNetEnv)
1921
- ... and some boilerplate code
2022

21-
Read the [Wiki](https://github.com/drwatson1/AspNet-Core-REST-Service/wiki) for more information.
22-
2323
Let me know, what do you think. Any suggestions and bug reports are very appreciated.
24+
25+
# Getting Started
26+
27+
28+
1. Install the extension from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=sergey-tregub.asp-net-core-restful-service-template#overview) or download and install the latest version from [GitHub](https://github.com/drwatson1/AspNet-Core-REST-Service/releases/latest). Also, you can install it from Visual Studio. To do so click on "Tools/Extensions and Updates..." menu item, then select "Online/Visual Studio Marketplace/Templates" on the left pane, search for "ASP.Net Core RESTful Service Template," select it and click "Download" button. Please note! The latest version of the template is targeted to the .Net Core 3.1. If you need a template for 2.x version use one of the previous version of the template.
29+
1. Restart Visual Studio
30+
1. Click on "File/New Project..." menu item
31+
1. Expand "Installed/Visual C#/.NET Core" on the left pane
32+
1. Select "APS.Net Core RESTful Service" and click OK button.
33+
1. Select either "IIS Express" or "ASPNetCore.Sevice1" mode and run a service
34+
1. Open a browser and navigate to [http://localhost:5000/swagger](http://localhost:5000/swagger) to see an API documentation
35+
1. Play around with the API. Try to add a new product or update one
36+
37+
Visit project [Wiki](https://github.com/drwatson1/AspNet-Core-REST-Service/wiki) pages to learn more about the template.
38+
39+
Have fun and happy hacking!

0 commit comments

Comments
 (0)