Skip to content

Commit 75c703c

Browse files
committed
Update readme
1 parent 24b7335 commit 75c703c

1 file changed

Lines changed: 18 additions & 16 deletions

File tree

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
1-
# ASP.Net WebApi2 Application with OWIN
1+
# ASP.Net Core RESTful Service Template
22

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

5-
- CORS enabled
6-
- preconfigured HTTP OPTIONS handler
7-
- Cache-Control header preconfigured
5+
Note! If you are looking for a classic ASP.Net services with WebAPI2 and other stuff like that, please, check out a project [
6+
ASP.Net WebApi2 Application with OWIN](https://github.com/drwatson1/AspNet-WebApi).
7+
8+
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.
9+
10+
However, there are some things that have to be implemented or configured in almost every project, regardless of the subject area. Among these things are dependency injection, exception handling, logging, and others. There are many libraries and solutions to address each of them, but it is impossible to choose a set that fits absolutely everyone. In this project I have collected the solutions that I, personally, consider the most convenient and use them for years in almost each of projects. I hope you like them too :) . So, the project contains these the most important features, but is not limited to them:
11+
12+
- CORS and preflight requests support
813
- Autofac as a DI-container
9-
- Content formatter configured to use Json.Net
1014
- AutoMapper
11-
- Unhandled exceptions handler
12-
- Unhandled exceptions logger
13-
- Serilog as a default logger preconfigured to save logs to %AppData%/Logs folder
14-
- Swagger for API documentation
15-
- JWT-Bearer authentication to protect your API with IdentityModel
16-
- Ability to use environment variables in configuration options (web.config)
17-
- Support .env files to easy switching between different environments (DotNetEnv)
18-
- ... and some other boilerplate code
15+
- Serilog as a default preconfigured logger
16+
- Unhandled exceptions handling
17+
- Swashbuckle for API documentation
18+
- Ability to use environment variables in configuration options and support for '.env' files to easy switching between different environments (thanks to DotNetEnv)
19+
- ... and some boilerplate code
20+
21+
Read [Wiki](https://github.com/drwatson1/AspNet-Core-REST-Service/wiki) for more information.
1922

20-
Read [Wiki](https://github.com/drwatson1/AspNet-WebApi/wiki) for more information.
21-
Any suggestions and bug reports are very appeciated.
23+
Let me know, what do think. Any suggestions and bug reports are very appreciated.

0 commit comments

Comments
 (0)